Class ValueHostBase<TConfig, TState>Abstract

Determines how the validation system sees the Value in terms of editing. When true, it was changed. When false, it was not. The setValue()/setInputValue()/setValues() functions are the only ones to change this flag. They all set it to true automatically except set it to false when the option.Reset is true. The ValueHost.validate() function may skip validation of an InputValueHost when IsChanged is false, depending on the options for validate. For example, calling validate immediately after loading up the form, you want to avoid showing Category=Require validators. Those should appear only if the user edits, or when the user attempts to submit.

Participates in releasing memory. While not required, the idea is to be a more friendly participant in the ecosystem. Note that once called, expect null reference errors to be thrown if any other functions try to use them.

Provides a unique name for this ValueHost. Consuming systems use this name to locate the ValueHost for which they will transfer a value, via ValueHostsManager.getValueHost(this name)

A user friendly name for this ValueHost, to be shown in tooltips, error messages, etc found in this ValueHostConfig that have the {Label} token. Localization should occur when setting up the ValueHostConfig.

Gets the native value, which is what can be written to the Model. Returns undefined if the native value could not be resolved from the input field/element.

System consumer assigns the native value to make it available to most Conditions during validation.

Consuming system calls this when it attempts to resolve the input field/element value but cannot. It identifies that the native value is undefined. Note this does not reset IsChanged to false without explicitly specifying options.Reset = true;

A name of a data type used to lookup supporting services specific to the data type. See the LookupKey. Some examples: "String", "Number", "Date", "DateTime", "MonthYear"

Provides a localized name for the data type when it needs to be shown to the user. Since the ValueHostConfig.dataType is optional, this will end up returning the empty string, unless the native value has been assigned and the DataTypeIdentifierService can figure out its lookupKey.

Determines if the ValueHost is enabled for user interaction. It is enabled unless you explicilty set it to false using ValueHostConfig.initialEnabled : false, setup the EnablerCondition which determines when it is enabled, or the ValueHost's own setEnabled() function.

When disabled, the data values of the ValueHost do not get changed by setValue() and related functions. However, those functions offer the overrideDisabled option to force the change.

When disabled and the ValueHost have validators, all validation is disabled and its ValidationStatus reports ValidationState.Disabled.

Sets the enabled state of the ValueHost. When false, the ValueHost is disabled and setValue() and related functions will not change the value. However, they offer the overrideDisabled option to force the change. When disabled and the ValueHost has validators, all validation is disabled and its ValidationStatus reports ValidationState.Disabled.

This value is part of the ValueHost's InstanceState, not the Config, although the ValueHostConfig.initialEnabled is used when it is not set in the state.

Use to change anything in ValueHostInstanceState without impacting the immutability of the current instance. Your callback will be passed a cloned instance. Change any desired properties and return that instance. It will become the new immutable value of the InstanceState property. If changes were made, the OnValueHostInstanceStateChanged event is fire.

Adds a custom entry into the ValueHost's state or removes it when value = undefined.

Use to retrieve a value from the state that was stored with saveIntoInstanceState().