Class RecipeUiOptionDto

Recipe description of a single UI option shared by menus and modals. Maps to a UiOption. Covers the flat fields (label, value/interaction type, a simple string default, translation flags) and the option's submit signals (submitSignals), wired through the serialized-property codec.

Inheritance

object

RecipeUiOptionDto

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.ProjectRecipe.Infrastructure.Editor.Model

Assembly: Serenity.UnityProjectRecipe.Infrastructure.Editor.dll

Syntax

public class RecipeUiOptionDto

Constructors

RecipeUiOptionDto()

Declaration

public RecipeUiOptionDto()

Fields

binding

Declaration

public RecipeUiOptionValueDto binding

Field Value

Type	Description
RecipeUiOptionValueDto	The option's bound value (`UiOption.Value`): what the option does or shows. Left as it is on an existing option when the recipe does not describe it.

defaultBinding

Declaration

public RecipeUiOptionValueDto defaultBinding

Field Value

Type	Description
RecipeUiOptionValueDto	The option's default value (`UiOption.DefaultValue`), whole.

defaultValue

Declaration

public string defaultValue

Field Value

Type	Description
string	Hand-authoring shortcut: a plain default value. On a new option it seeds both the bound value and the default; on an existing option it sets only the default's value. Ignored when defaultBinding is described; the exporter writes the bindings instead and leaves this empty.

guid

Declaration

public string guid

Field Value

Type	Description
string	The option's own Guid, the identity an import matches it by; empty matches by id.

id

Declaration

public string id

Field Value

Type	Description
string	Stable logical identifier of the option. Required.

interactionType

Declaration

public string interactionType

Field Value

Type	Description
string	Interaction type, as a `UiComponentInteractionType` name (`STRING`, `TOGGLE`, `SELECTOR`, `SLIDER`, `DROPDOWN`, `INPUT`, `SUBMIT`). Empty defaults to `STRING`.

isTranslatingLabel

Declaration

public bool isTranslatingLabel

Field Value

Type	Description
bool	Whether the label is treated as a localization key at runtime.

isTranslatingValue

Declaration

public bool isTranslatingValue

Field Value

Type	Description
bool	Whether the value is treated as a localization key at runtime.

label

Declaration

public string label

Field Value

Type	Description
string	Display label of the option.

submitSignals

Declaration

public RecipeSignalDto[] submitSignals

Field Value

Type	Description
RecipeSignalDto[]	Signals dispatched when the option is submitted, in order (maps to `UiOption.OnSubmitSignals`). Each is matched to one the option already owns by its guid (by position and type when either side has none) and edited in place; a signal the recipe leaves out is left untouched, a new one is appended, and listing every signal in another order reorders them. `null` leaves the signals untouched.

valueType

Declaration

public string valueType

Field Value

Type	Description
string	Value type, as a `UiComponentValueType` name (`INT`, `FLOAT`, `STRING`, `BOOL`, `SELECTABLE`, `TRANSITION`, `ACTION`). Empty defaults to `STRING`.