ValidationSummary
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.
You can create the ValidationSummary widget using one of the following approaches.
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>
export class AppComponent { validate(params) { params.validationGroup.validate(); } }
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>
Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.
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
An object defining configuration options for the widget.
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 an item. |
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
This section describes members used to manipulate the widget.
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. |
element() | Gets the root element of the widget. |
endUpdate() | Refreshes the widget after a call of the beginUpdate() method. |
instance() | Returns this widget's instance. Use it to access other methods of the widget. |
off(eventName) | Detaches all event handlers from the specified event. |
off(eventName, eventHandler) | Detaches a particular event handler from the specified event. |
on(eventName, eventHandler) | Subscribes to a specified event. |
on(events) | Subscribes to the specified events. |
option() | Gets the widget's options. |
option(optionName) | Gets a specific option value. |
option(optionName, optionValue) | Assigns a new value to a specific option. |
option(options) | Sets one or more options. |
repaint() | Repaints the widget. Call it if you made modifications that changed the widget's state to invalid. |
Events
This section describes events fired by this widget.
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 an option of the widget is changed. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
Default Item Template
This section lists the data source fields that are used in a 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.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.