Class UIListBoxControlOption

A structure that describes a single entry in a UIListBoxControl.

Index

Constructors

Properties

Accessors

Methods

assign clone isEqual isEqual

Constructors

constructor

new UIListBoxControlOption(
label?: Immutable<UIContent>,
value?: number,
): UIListBoxControlOption
Parameters
- Optionallabel: Immutable<UIContent>
- Optionalvalue: number
Returns UIListBoxControlOption

Properties

`Protected`_label

_label: UIContent

`Protected`_value

_value: number

Accessors

label

get label(): UIContent

The label to be shown in the control when selecting the value.

Returns UIContent
set label(value: Immutable<UIContent>): void
Parameters
- value: Immutable<UIContent>
Returns void

value

get value(): number

The value to set the control when the value is selected.

Returns number
set value(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<UIListBoxControlOption>): UIListBoxControlOption
Copies all properties defined by the prototype of UIListBoxControlOption from other to this instance.
Parameters
- other: Immutable<UIListBoxControlOption>
Returns UIListBoxControlOption

clone

clone(): UIListBoxControlOption

Clones this instance and returns a new UIListBoxControlOption with identical values.

Returns UIListBoxControlOption

isEqual

isEqual(
this: Immutable<UIListBoxControlOption>,
other: Immutable<UIListBoxControlOption>,
): boolean
Determines if this UIListBoxControlOption instance is equal to the other instance.
Parameters
- this: Immutable<UIListBoxControlOption>
- other: Immutable<UIListBoxControlOption>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<UIListBoxControlOption>,
rhs: Immutable<UIListBoxControlOption>,
): boolean
Determines if both UIListBoxControlOption instances are equal.
Parameters
- lhs: Immutable<UIListBoxControlOption>
- rhs: Immutable<UIListBoxControlOption>
Returns boolean