Validator Event Handlers Types (T1269388) (DevExpress#6976)

mpreyskurantov · web-flow · commit c15188e31203 · 2025-01-21T08:09:04.000+02:00
diff --git a/api-reference/10 UI Components/dxValidationGroup/9 Validation Result/Validation Result.md b/api-reference/10 UI Components/dxValidationGroup/9 Validation Result/Validation Result.md
@@ -3,6 +3,7 @@ id: dxValidationGroupResult
 type: Object
 module: ui/validation_group
 export: dxValidationGroupResult
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/1 Configuration/onDisposing.md b/api-reference/10 UI Components/dxValidator/1 Configuration/onDisposing.md
@@ -0,0 +1,19 @@
+---
+id: dxValidator.Options.onDisposing
+type: function(e)
+---
+---
+##### shortDescription
+A function that is executed before the UI component is [disposed of](/api-reference/10%20UI%20Components/dxValidator/3%20Methods/dispose().md '{basewidgetpath}/Methods/#dispose').
+
+##### param(e): ui/validator:DisposingEvent
+Information about the event.
+
+##### field(e.component): {WidgetName}
+The UI component's instance.
+
+##### field(e.element): DxElement
+#include common-ref-elementparam with { element: "UI component" }
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/1 Configuration/onInitialized.md b/api-reference/10 UI Components/dxValidator/1 Configuration/onInitialized.md
@@ -0,0 +1,23 @@
+---
+id: dxValidator.Options.onInitialized
+type: function(e)
+---
+---
+##### shortDescription
+A function used in JavaScript frameworks to save the UI component instance.
+
+##### param(e): ui/validator:InitializedEvent
+Information about the event.
+
+##### field(e.component): {WidgetName}
+The UI component's instance.
+
+##### field(e.element): DxElement
+#include common-ref-elementparam with { element: "UI component" }
+
+---
+#include common-code-on-initialized
+
+#####See Also#####
+
+#include common-get-instance
diff --git a/api-reference/10 UI Components/dxValidator/1 Configuration/onOptionChanged.md b/api-reference/10 UI Components/dxValidator/1 Configuration/onOptionChanged.md
@@ -0,0 +1,31 @@
+---
+id: dxValidator.Options.onOptionChanged
+type: function(e)
+---
+---
+##### shortDescription
+A function that is executed after a UI component property is changed.
+
+##### param(e): ui/validator:OptionChangedEvent
+Information about the event.
+
+##### field(e.component): {WidgetName}
+The UI component's instance.
+
+##### field(e.element): DxElement
+#include common-ref-elementparam with { element: "UI component" }
+
+##### field(e.fullName): String
+The path to the modified property that includes all parent properties.
+
+##### field(e.name): String
+The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
+
+##### field(e.previousValue): any
+The UI component's previous value.
+
+##### field(e.value): any
+The modified property's new value.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/1 Configuration/onValidated.md b/api-reference/10 UI Components/dxValidator/1 Configuration/onValidated.md
@@ -6,13 +6,13 @@ type: function(validatedInfo)
 ##### shortDescription
 A function that is executed after a value is validated.
 
-##### param(validatedInfo): Object
+##### param(validatedInfo): ui/validator:ValidatedEvent
 Information about the event.
 
-##### field(validatedInfo.brokenRule): RequiredRule | NumericRule | RangeRule | StringLengthRule | CustomRule | CompareRule | PatternRule | EmailRule | AsyncRule
+##### field(validatedInfo.brokenRule): ValidationRule
 The object that represents the first broken rule on the list of specified validation rules.
 
-##### field(validatedInfo.brokenRules): Array<RequiredRule, NumericRule, RangeRule, StringLengthRule, CustomRule, CompareRule, PatternRule, EmailRule, AsyncRule>
+##### field(validatedInfo.brokenRules): Array<ValidationRule>
 An array of [validationRules](/api-reference/10%20UI%20Components/dxValidator/8%20Validation%20Rules '/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/') that failed to pass the check.
 
 ##### field(validatedInfo.isValid): Boolean
@@ -24,7 +24,7 @@ The value of the [name](/api-reference/10%20UI%20Components/dxValidator/1%20Conf
 ##### field(validatedInfo.status): Enums.ValidationStatus
 Indicates the validation [status](/api-reference/10%20UI%20Components/dxValidator/9%20Validation%20Result/status.md '/Documentation/ApiReference/UI_Components/dxValidator/Validation_Result/#status').
 
-##### field(validatedInfo.validationRules): Array<RequiredRule, NumericRule, RangeRule, StringLengthRule, CustomRule, CompareRule, PatternRule, EmailRule, AsyncRule>
+##### field(validatedInfo.validationRules): Array<ValidationRule>
 An array of validation rules specified for the current **dxValidator** object.
 
 ##### field(validatedInfo.value): Object
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/AsyncRule/AsyncRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/AsyncRule/AsyncRule.md
@@ -3,6 +3,7 @@ id: AsyncRule
 type: Object
 module: common
 export: AsyncRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/CompareRule/CompareRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/CompareRule/CompareRule.md
@@ -3,6 +3,7 @@ id: CompareRule
 type: Object
 module: common
 export: CompareRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/CustomRule/CustomRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/CustomRule/CustomRule.md
@@ -3,6 +3,7 @@ id: CustomRule
 type: Object
 module: common
 export: CustomRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/EmailRule/EmailRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/EmailRule/EmailRule.md
@@ -3,6 +3,7 @@ id: EmailRule
 type: Object
 module: common
 export: EmailRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/NumericRule/NumericRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/NumericRule/NumericRule.md
@@ -3,6 +3,7 @@ id: NumericRule
 type: Object
 module: common
 export: NumericRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/PatternRule/PatternRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/PatternRule/PatternRule.md
@@ -3,6 +3,7 @@ id: PatternRule
 type: Object
 module: common
 export: PatternRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/RangeRule/RangeRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/RangeRule/RangeRule.md
@@ -3,6 +3,7 @@ id: RangeRule
 type: Object
 module: common
 export: RangeRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/RequiredRule/RequiredRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/RequiredRule/RequiredRule.md
@@ -3,6 +3,7 @@ id: RequiredRule
 type: Object
 module: common
 export: RequiredRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/8 Validation Rules/StringLengthRule/StringLengthRule.md b/api-reference/10 UI Components/dxValidator/8 Validation Rules/StringLengthRule/StringLengthRule.md
@@ -3,6 +3,7 @@ id: StringLengthRule
 type: Object
 module: common
 export: StringLengthRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/9 Validation Result/Validation Result.md b/api-reference/10 UI Components/dxValidator/9 Validation Result/Validation Result.md
@@ -3,6 +3,7 @@ id: dxValidatorResult
 type: Object
 module: ui/validator
 export: dxValidatorResult
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/DisposingEvent/DisposingEvent.md b/api-reference/10 UI Components/dxValidator/99 Types/DisposingEvent/DisposingEvent.md
@@ -0,0 +1,15 @@
+---
+module: ui/validator
+export: DisposingEvent
+type: Object
+inherits: EventInfo
+references: dxValidator.Options.onDisposing
+uid: ui/validator:DisposingEvent
+generateTypeLink: 
+---
+---
+##### shortDescription
+The type of the [disposing]({basewidgetpath}/Events/#disposing) event handler's argument.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/InitializedEvent/InitializedEvent.md b/api-reference/10 UI Components/dxValidator/99 Types/InitializedEvent/InitializedEvent.md
@@ -0,0 +1,15 @@
+---
+module: ui/validator
+export: InitializedEvent
+type: Object
+inherits: InitializedEventInfo
+references: dxValidator.Options.onInitialized
+uid: ui/validator:InitializedEvent
+generateTypeLink: 
+---
+---
+##### shortDescription
+The type of the [initialized]({basewidgetpath}/Events/#initialized) event handler's argument.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/OptionChangedEvent/OptionChangedEvent.md b/api-reference/10 UI Components/dxValidator/99 Types/OptionChangedEvent/OptionChangedEvent.md
@@ -0,0 +1,15 @@
+---
+module: ui/validator
+export: OptionChangedEvent
+type: Object
+inherits: EventInfo,ChangedOptionInfo
+references: dxValidator.Options.onOptionChanged
+uid: ui/validator:OptionChangedEvent
+generateTypeLink: 
+---
+---
+##### shortDescription
+The type of the [optionChanged]({basewidgetpath}/Events/#optionChanged) event handler's argument.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/Types.md b/api-reference/10 UI Components/dxValidator/99 Types/Types.md
@@ -0,0 +1,4 @@
+---
+##### shortDescription
+
+---
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/ValidatedEvent.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/ValidatedEvent.md
@@ -0,0 +1,14 @@
+---
+module: ui/validator
+export: ValidatedEvent
+type: Object
+references: dxValidator.Options.onValidated
+uid: ui/validator:ValidatedEvent
+generateTypeLink: 
+---
+---
+##### shortDescription
+The type of the [validated]({basewidgetpath}/Events/#validated) event handler's argument.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/brokenRule.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/brokenRule.md
@@ -0,0 +1,10 @@
+---
+type: ValidationRule
+uid: ui/validator:ValidatedEvent.brokenRule
+---
+---
+##### shortDescription
+The object that represents the first broken rule on the list of specified validation rules.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/brokenRules.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/brokenRules.md
@@ -0,0 +1,10 @@
+---
+type: Array<ValidationRule>
+uid: ui/validator:ValidatedEvent.brokenRules
+---
+---
+##### shortDescription
+An array of [validationRules](/api-reference/10%20UI%20Components/dxValidator/8%20Validation%20Rules '/Documentation/ApiReference/UI_Components/dxValidator/Validation_Rules/') that failed to pass the check.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/isValid.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/isValid.md
@@ -0,0 +1,10 @@
+---
+type: Boolean
+uid: ui/validator:ValidatedEvent.isValid
+---
+---
+##### shortDescription
+Indicates whether the value satisfies all rules.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/name.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/name.md
@@ -0,0 +1,10 @@
+---
+type: String
+uid: ui/validator:ValidatedEvent.name
+---
+---
+##### shortDescription
+The value of the [name](/api-reference/10%20UI%20Components/dxValidator/1%20Configuration/name.md '/Documentation/ApiReference/UI_Components/dxValidator/Configuration/#name') property.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/status.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/status.md
@@ -0,0 +1,10 @@
+---
+type: Enums.ValidationStatus
+uid: ui/validator:ValidatedEvent.status
+---
+---
+##### shortDescription
+Indicates the validation [status](/api-reference/10%20UI%20Components/dxValidator/9%20Validation%20Result/status.md '/Documentation/ApiReference/UI_Components/dxValidator/Validation_Result/#status').
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/validationRules.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/validationRules.md
@@ -0,0 +1,10 @@
+---
+type: Array<ValidationRule>
+uid: ui/validator:ValidatedEvent.validationRules
+---
+---
+##### shortDescription
+An array of validation rules specified for the current **dxValidator** object.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/value.md b/api-reference/10 UI Components/dxValidator/99 Types/ValidatedEvent/value.md
@@ -0,0 +1,10 @@
+---
+type: Object
+uid: ui/validator:ValidatedEvent.value
+---
+---
+##### shortDescription
+The validated value.
+
+---
+<!-- Description goes here -->
diff --git a/api-reference/40 Common Types/ValidationRule.md b/api-reference/40 Common Types/ValidationRule.md
@@ -3,6 +3,7 @@ id: ValidationRule
 module: common
 export: ValidationRule
 type: AsyncRule | CompareRule | CustomRule | EmailRule | NumericRule | PatternRule | RangeRule | RequiredRule | StringLengthRule
+generateTypeLink: 
 ---
 ---
 ##### shortDescription
diff --git a/api-reference/40 Common Types/ValidationStatus.md b/api-reference/40 Common Types/ValidationStatus.md
@@ -2,7 +2,7 @@
 id: Enums.ValidationStatus
 acceptValues: 'valid' | 'invalid' | 'pending'
 type: Union
-references: dxValidationGroupResult.status|dxValidator.Options.onValidated|dxValidatorResult.status|Editor.Options.validationStatus
+references: ui/validator:ValidatedEvent.status|dxValidationGroupResult.status|dxValidator.Options.onValidated|dxValidatorResult.status|Editor.Options.validationStatus
 ---
 ---
 ##### shortDescription
diff --git a/metadata/syntax-data.json b/metadata/syntax-data.json
@@ -4763,6 +4763,16 @@
       "react": "_ui_validation_summary_OptionChangedEvent",
       "vue": "Dx_ui_validation_summary_OptionChangedEvent"
     },
+    "_ui_validator_DisposingEvent": {
+      "angular": "dxo-ui-validator--disposing-event",
+      "react": "_ui_validator_DisposingEvent",
+      "vue": "Dx_ui_validator_DisposingEvent"
+    },
+    "_ui_validator_OptionChangedEvent": {
+      "angular": "dxo-ui-validator--option-changed-event",
+      "react": "_ui_validator_OptionChangedEvent",
+      "vue": "Dx_ui_validator_OptionChangedEvent"
+    },
     "_viz_bar_gauge_DisposingEvent": {
       "angular": "dxo-viz-bar-gauge--disposing-event",
       "react": "_viz_bar_gauge_DisposingEvent",
@@ -19179,6 +19189,15 @@
     "dxValidatorOptions.adapter.validationRequestsCallbacks": {
       "vue": "validation-requests-callbacks"
     },
+    "dxValidatorOptions.onDisposing": {
+      "vue": "@disposing"
+    },
+    "dxValidatorOptions.onInitialized": {
+      "vue": "@initialized"
+    },
+    "dxValidatorOptions.onOptionChanged": {
+      "vue": "@option-changed"
+    },
     "dxValidatorOptions.onValidated": {
       "vue": "@validated"
     },
