Optional onCalled when the InputValueHost's InputValue property has changed. If setup, you can prevent it from being fired with the options parameter of setValue() to avoid round trips where you already know the details. You can setup the same callback on individual InputValueHosts. Here, it aggregates all InputValueHost notifications.
Optional savedThe InstanceState for the ValueHostsManager itself. Its up to you to retain stateful information so that the service works statelessly. It will supply you with the changes to states through the OnInstanceStateChanged property. Whatever it gives you, you supply here to rehydrate the ValueHostsManager with the correct state. If you don't have any state, leave this null or undefined and ValueHostsManager will initialize its state.
The state for each ValueHost. The array may not have the same states for all the ValueHostConfigs you are supplying. It will create defaults for those missing and discard those no longer in use.
Its up to you to retain stateful information so that the service works statelessly. It will supply you with the changes to states through the OnValueHostInstanceStateChanged property. Whatever it gives you, you supply here to rehydrate the ValueHostsManager with the correct state. You can also supply the state of an individual ValueHost when using the addValueHost or addOrUpdateValueHost methods. If you don't have any state, leave this null or undefined and ValueHostsManager will initialize its state.
Optional onCalled when the state of validation has changed on a ValidatableValueHost. That includes validate(), clearValidation(), setBusinessLogicErrors(), clearBusinessLogicErrors() and a few edge cases. Supplies the current ValidationState to the callback. Examples: Use to notify the validation related aspects of the component to refresh, such as showing error messages and changing style sheets. Use to change the disabled state of the submit button based on validity. See also onValidationStateChanged for a similar callback from the ValidationManager.
Optional onCalled when the state of validation has changed on a ValidatableValueHost. That includes validate(), clearValidation(), setBusinessLogicErrors(), clearBusinessLogicErrors() and a few edge cases. Supplies the current ValidationState to the callback. Examples: Use to notify the Validation Summary widget(s) to refresh. Use to change the disabled state of the submit button based on validity. See also onValueHostValidationStateChanged for a similar callback from individual ValueHosts.
Optional notifyProvides a debounce delay for onValidationStateChanged notifications. The delay is in milliseconds.
onValidationStateChanged runs after each valueHost.validate() call, even though onValueHostValidationStateChanged also runs. Some features need to know about the general change to the validation state, not just on the individual field. So they expect onValidationStateChanged to run after valueHost.validate() runs. A call by ValidationManager.validate() will validate a list of valueHosts, and all of them will try to invoke onValidationStateChanged. That's too many in a short period. This debounces them so ValidationManager.validated() generally has one call.
Leave undefined to use the default of defaultNotifyValidationStateChangedDelay. Set to 0 to disable the debounce.
Optional onCalled when any ValueHost had its ValueHostInstanceState changed. React example: React component useState feature retains this value and needs to know when to call the setValueHostInstanceState() with the stateToRetain. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.
Optional onCalled when the ValueHost's Value property has changed. If setup, you can prevent it from being fired with the options parameter of setValue() to avoid round trips where you already know the details. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.
Optional onCalled when the ValueHostsManager's InstanceState has changed. React example: React component useState feature retains this value and needs to know when to call the setState function with the stateToRetain
Optional onUse this when caching the configuration for a later creation of ValueHostsManager.
Called when the configuration of ValueHosts has been changed, usually through the ValueHostsManagerConfigModifier.apply, or these members of ValueHostsManager: addValueHost, addOrUpdateValueHost, addOrMergeValueHost, discardValueHost. The supplied object is a clone so modifications will not impact the ValueHostsManager.
Note that where a ValueHostConfig has a property that references a function, you will have to retain that reference in some way to reuse it. In particular, ValidatorConfig.conditionCreator.
If the user needs to abandon this instance, they should use this to clean up active resources (like timers) and to release memory that would stall the garbage collector from disposing this object. It should assign any object reference to undefined as a strong indicator that the object has been disposed.
When working with both business layer and UI layer configurations, call before starting the UI layer configuration. It will prepare for merging overlapping configurations and optionally change some of the configuration already prepared by the business layer.
Optional options: BuilderOverrideOptionsFluent format to create a StaticValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
the ValueHost name
Optional dataType: null | stringoptional and can be null. The value for ValueHost.dataType.
Optional parameters: FluentStaticParametersoptional. Any additional properties of a StaticValueHostConfig.
Same instance for chaining.
Fluent format to create a StaticValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
the ValueHost name
optional. Any additional properties of a StaticValueHostConfig.
Same instance for chaining.
Fluent format to create a StaticValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
Supply the entire StaticValueHostConfig. This is a special use case. You can omit the valueHostType property.
Same instance for chaining.
Optional arg2: null | string | FluentStaticParametersOptional parameters: FluentStaticParametersFluent format to create a CalcValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
the ValueHost name
can be null. The value for ValueHost.dataType.
required. Function callback.
Same instance for chaining.
Fluent format to create a CalcValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
Supply the entire CalcValueHostConfig. This is a special use case. You can omit the valueHostType property.
Same instance for chaining.
Optional dataType: null | stringOptional calcFn: CalculationHandlerFluent format to create a InputValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
Optional dataType: null | stringoptional and can be null. The value for ValueHost.dataType.
Optional parameters: FluentInputParametersoptional. Any additional properties of a InputValueHostConfig.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Fluent format to create a InputValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
optional. Any additional properties of a InputValueHostConfig.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Fluent format to create a InputValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
Supply the entire InputValueHostConfig. This is a special use case. You can omit the valueHostType property.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Optional arg2: null | string | FluentInputParametersOptional parameters: FluentInputParametersFluent format to create a PropertyValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
Optional dataType: null | stringoptional and can be null. The value for ValueHost.dataType.
Optional parameters: FluentPropertyParametersoptional. Any additional properties of a PropertyValueHostConfig.
FluentValidatorBuilder for chaining validators to initial PropertyValueHost
Fluent format to create a PropertyValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
optional. Any additional properties of a PropertyValueHostConfig.
FluentValidatorBuilder for chaining validators to initial PropertyValueHost
Fluent format to create a PropertyValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
Supply the entire PropertyValueHostConfig. This is a special use case. You can omit the valueHostType property.
FluentValidatorBuilder for chaining validators to initial PropertyValueHost
Optional arg2: null | string | FluentPropertyParametersOptional parameters: FluentPropertyParametersGenerated using TypeDoc v0.25.12
A builder for preparing ValidationManagerConfig.