jQuery ValidationSummary API
A widget for displaying the result of checking validation rules for editors.
This widget has a collection of items that present the validation errors that currently exist in a validation group or the ViewModel to which the widget is related.
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the ValidationSummary widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
$(function() {
var validationGroupName = "sampleGroup";
$("#textBox1").dxTextBox({ name: 'FirstName' })
.dxValidator({
validationRules: [
// ...
],
validationGroup: validationGroupName
});
$("#textBox2").dxTextBox({ name: 'LastName' })
.dxValidator({
validationRules: [
// ...
],
validationGroup: validationGroupName
});
$("#summary").dxValidationSummary({
validationGroup: validationGroupName
});
$("#button").dxButton({
validationGroup: validationGroupName,
text: 'Validate',
onClick: function validate (params) {
params.validationGroup.validate();
}
});
});<div id="textBox1"></div> <div id="textBox2"></div> <div id="summary"></div> <div id="button"></div>
Angular
<dx-validation-group>
<dx-text-box name="FirstName">
<dx-validator>
<dxi-validation-rule type="required" message="First name is required"></dxi-validation-rule>
...
</dx-validator>
</dx-text-box>
<dx-text-box name="LastName">
<dx-validator>
<dxi-validation-rule type="required" message="Last name is required"></dxi-validation-rule>
...
</dx-validator>
</dx-text-box>
<dx-validation-summary></dx-validation-summary>
<dx-button
text="Validate"
(onClick)="validate()">
</dx-button>
</dx-validation-group>
import { DxValidationSummaryModule, DxValidationGroupModule, DxTextBoxModule, DxButtonModule, DxValidatorModule } from 'devextreme-angular'
// ...
export class AppComponent {
validate(params) {
params.validationGroup.validate();
}
}
@NgModule({
imports: [
// ...
DxValidationSummaryModule,
DxValidationGroupModule,
DxTextBoxModule,
DxButtonModule,
DxValidatorModule
],
// ...
})AngularJS
<div dx-validation-group="{ }" ng-controller="DemoController">
<div dx-text-box="{ name: 'FirstName' }"
dx-validator="{
validationRules: [
// ...
]
}">
</div>
<div dx-text-box="{ name: 'LastName' }"
dx-validator="{
validationRules: [
// ...
]
}">
</div>
<div dx-validation-summary="{ }"></div>
<div dx-button="{
text: 'Validate',
onClick: validate
}"></div>
</div>angular.module('DemoApp', ['dx'])
.controller("DemoController", function ($scope) {
$scope.validate = function validate (params) {
params.validationGroup.validate();
};
});Knockout
<div data-bind="dxValidationGroup: { }" >
<div data-bind="dxTextBox: { name: 'FirstName' },
dxValidator: {
validationRules: [
// ...
]
}">
</div>
<div data-bind="dxTextBox: { name: 'LastName' },
dxValidator: {
validationRules: [
// ...
]
}">
</div>
<div data-bind="dxValidationSummary: { }"></div>
<div data-bind="dxButton: {
text: 'Validate',
onClick: function validate (params) {
params.validationGroup.validate();
}
}"></div>
</div>ASP.NET MVC Controls
using (Html.DevExtreme().ValidationGroup()) {
@(Html.DevExtreme().TextBox()
.Name("FirstName")
)
@(Html.DevExtreme().TextBox()
.Name("LastName")
)
@(Html.DevExtreme().ValidationSummary())
@(Html.DevExtreme().Button()
.Text("Validate")
.OnClick(@<text>
function validate (params) {
params.validationGroup.validate();
}
</text>)
)
}@Using (Html.DevExtreme().ValidationGroup())
@(Html.DevExtreme().TextBox() _
.Name("FirstName")
)
@(Html.DevExtreme().TextBox() _
.Name("LastName")
)
@(Html.DevExtreme().ValidationSummary())
@(Html.DevExtreme().Button() _
.Text("Validate") _
.OnClick("validate")
)
End Using
<script>
function validate(params) {
params.validationGroup.validate();
}
</script>The summary items are displayed using the default item template that is based on the message field of the broken validation rule. However, you can use a custom item template.
See Also
To learn more on how to create the ValidationSummary widget and associate it with the required validation group or ViewModel, refer to the Display Validation Errors and Knockout Only - Validate a View Model topics.
See Also
Configuration
| Name | Description |
|---|---|
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| items |
An array of items displayed by the widget. |
| itemTemplate |
Specifies a custom template for items. |
| onContentReady |
A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes. |
| onDisposing |
A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| onInitialized |
A handler for the initialized event. Executed only once, after the widget is initialized. |
| onItemClick |
A handler for the itemClick event. |
| onOptionChanged |
A handler for the optionChanged event. Executed after an option of the widget is changed. |
| validationGroup |
Specifies the validation group for which summary should be generated. |
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the ValidationSummary instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| repaint() |
Repaints the widget. Call it if you made modifications that changed the widget's state to invalid. |
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the widget's content is ready. |
| disposing |
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| initialized |
Raised only once, after the widget is initialized. |
| itemClick |
Fires when a widget item is clicked. |
| optionChanged |
Raised after a widget option is changed. |
Default Item Template
By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is the list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.