Elements of ValueHost that are stateful based on user interaction

interface ValueHostInstanceState {
    name: string;
    value: any;
    enabled?: boolean;
    changeCounter?: number;
    items?: CustomItems;
}

Hierarchy (view full)

Properties

name: string

The ValueHostName for the associated ValueHost. Despite being in instanceState, this property is not allowed to be changed.

value: any

The value available to be evaluated by Conditions. It is expected to be in its native data type, capable of being stored or used without conversion by the caller. For example, a Date object or Number type. Value of undefined is valid. Use undefined if the native value could not be resolved from the input field/element or is otherwise unknown.

enabled?: boolean

The latest value of setEnabled. When undefined, it uses the ValueHostConfig.initialEnabled and if that is undefined, it is enabled. Note that this value overrides any EnablerCondition that may be setup.

changeCounter?: number

Counts the number of changes made to the Value thru setValue() and related functions. Increments with each call or sets it back to 0 when their option.Reset is true. When 0 or undefined, it means no changes have been made.

items?: CustomItems

Storage associated with ValueHost.saveIntoInstanceState/getFromInstanceState

Generated using TypeDoc v0.25.12