Elements of InputValueHost that are stateful based on user interaction

interface InputValueHostInstanceState {
    inputValue?: any;
    conversionErrorTokenValue?: string;
    group?: string;
    businessLogicErrors?: BusinessLogicError[];
    asyncProcessing?: boolean;
    status: ValidationStatus;
    issuesFound: null | IssueFound[];
    corrected?: boolean;
    name: string;
    value: any;
    enabled?: boolean;
    changeCounter?: number;
    items?: CustomItems;
}

Hierarchy (view full)

Properties

inputValue?: any

The value from the input field/element, even if invalid. The value may not be the native data type. For example, it could be a string from an whose dataType=Date, meaning the Value property must be a Date object. Will be 'undefined' if the value has not been retrieved.

conversionErrorTokenValue?: string

When converting the input field/element value to native and there is an error it should be saved here. It can be displayed as part of the DataTypeCheckCondition's error message token {ConversionError}. Cleared when setting the value without an error.

group?: string

Group used when validate() was last called. It is associated with the current IssuesFound.

businessLogicErrors?: BusinessLogicError[]

If there are any business logic errors, they are kept here. If not, this is undefined.

asyncProcessing?: boolean

When true, an async Validator is running

The state of validation for this ValueHost.

issuesFound: null | IssueFound[]

The issues that were found.

corrected?: boolean

Set to true when the user has fixed all invalid validators. Undefined or false otherwise, including if the status changes after this point.

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