logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UiOptionValue

    Represents a base class for UI option values.

    Inheritance
    object
    UiOptionValue
    UiOptionBoolValue
    UiOptionFloatValue
    UiOptionIntegerValue
    UiOptionMenuActionValue
    UiOptionMenuTransitionValue
    UiOptionSelectableValue
    UiOptionStringValue
    Implements
    IFoundationSettings
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.Ui.Domain.Entities
    Assembly: Serenity.Ui.Domain.dll
    Syntax
    public class UiOptionValue : IFoundationSettings

    Constructors

    UiOptionValue(string, string, string, UiComponentInteractionType)

    Initializes a new instance of the UiOptionValue class.

    Declaration
    public UiOptionValue(string id, string viewId, string value, UiComponentInteractionType uiElement)
    Parameters
    Type Name Description
    string id

    The unique identifier of the option.

    string viewId

    The view identifier of the option.

    string value

    The string value of the option.

    UiComponentInteractionType uiElement

    The interaction type of the UI element.

    Fields

    Guid

    Declaration
    public string Guid
    Field Value
    Type Description
    string

    The view identifier of the option.

    Id

    Declaration
    public string Id
    Field Value
    Type Description
    string

    The unique identifier of the option.

    UiElement

    Declaration
    public UiComponentInteractionType UiElement
    Field Value
    Type Description
    UiComponentInteractionType

    The interaction type of the UI element.

    Value

    Declaration
    public string Value
    Field Value
    Type Description
    string

    The value of the option as a string.

    ViewId

    Declaration
    public string ViewId
    Field Value
    Type Description
    string

    The view identifier of the option.

    Methods

    GetStringValue()

    Gets the string value of the option.

    Declaration
    public virtual string GetStringValue()
    Returns
    Type Description
    string

    The string value of the option.

    SetValue(string)

    Sets the string value of the option.

    Declaration
    public virtual void SetValue(string value)
    Parameters
    Type Name Description
    string value

    The new string value to set.

    ToString()

    Returns a string representation of the UI option value.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of the UI option value.

    Overrides
    object.ToString()

    Implements

    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved