Additional options for setInputValue().

interface SetInputValueOptions {
    disableParser?: boolean;
    validate?: boolean;
    duringEdit?: boolean;
    reset?: boolean;
    conversionErrorTokenValue?: string;
    skipValueChangedCallback?: boolean;
    overrideDisabled?: boolean;
}

Hierarchy (view full)

Properties

disableParser?: boolean

When true, do not use the DataTypeParser to convert the input value into its native value.

validate?: boolean

Perform validation if ValueHost supports it. That may result in a state change passed up.

duringEdit?: boolean

Only applies when validate option is true Set to true when handling an intermediate change activity, such as a keystroke changed a textbox but the user remains in the textbox. For example, on the HTMLInputElement.oninput event. This will involve only validators that make sense during such an edit. Specifically their Condition implements IEvaluateConditionDuringEdits. The IEvaluateConditionDuringEdits.evaluateDuringEdit() function is used instead of ICondition.evaluate(). When undefined, it is the same as false.

reset?: boolean

Reset the field's changed and validation states as if the field has never been edited. It effectively sets ValueHost.IsChanged to false and calls ValidatableValueHost.clearValidation().

conversionErrorTokenValue?: string

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

skipValueChangedCallback?: boolean

If you have setup the OnValueChanged callback, it automatically is run when a value is changed. Use this to skip that callback. Callback is skipped when true. When null, it is the same as false.

overrideDisabled?: boolean

When true, it forces the change to the value even when the ValueHost is disabled. ValueHost is disabled when ValueHost.isEnabled() returns false. Use case: You may want to initialize a ValueHost with a value that is disabled.

Generated using TypeDoc v0.25.12