React ValidationSummary Methods

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Function	Device parameters. When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

options

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the ValidationSummary UI component in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxValidationSummary.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the ValidationSummary properties
    }
});

Angular

TypeScript

import ValidationSummary, { Properties } from "devextreme/ui/validation_summary";
// ...
export class AppComponent {
    constructor () {
        ValidationSummary.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the ValidationSummary properties
            }
        });
    }
}

Vue

<template>
    <div>
        <DxValidationSummary id="validationSummary1" />
        <DxValidationSummary id="validationSummary2" />
    </div>
</template>
<script>
import DxValidationSummary from "devextreme-vue/validation-summary";
import ValidationSummary from "devextreme/ui/validation_summary";

ValidationSummary.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the ValidationSummary properties
    }
});

export default {
    components: {
        DxValidationSummary
    }
}
</script>

React

import dxValidationSummary from "devextreme/ui/validation_summary";
import ValidationSummary from "devextreme-react/validation-summary";

dxValidationSummary.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the ValidationSummary properties
    }
});

export default function App() {
    return (
        <div>
            <ValidationSummary id="validationSummary1" />
            <ValidationSummary id="validationSummary2" />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the ValidationSummary instance.

jQuery

After calling this method, remove the DOM element associated with the UI component:

JavaScript

$("#myValidationSummary").dxValidationSummary("dispose");
$("#myValidationSummary").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

<dx-validation-summary ...
    *ngIf="condition">
</dx-validation-summary>

Vue

Use conditional rendering instead of this method:

App.vue

<template>
    <DxValidationSummary ...
        v-if="condition">
    </DxValidationSummary>
</template>

<script>
import DxValidationSummary from 'devextreme-vue/validation-summary';

export default {
    components: {
        DxValidationSummary
    }
}
</script>

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import ValidationSummary from 'devextreme-react/validation-summary';

function DxValidationSummary(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <ValidationSummary ... >    
        </ValidationSummary>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxValidationSummary shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the ValidationSummary instance found in an element with the myValidationSummary ID:

// Modular approach
import ValidationSummary from "devextreme/ui/validation_summary";
...
let element = document.getElementById("myValidationSummary");
let instance = ValidationSummary.getInstance(element) as ValidationSummary;

// Non-modular approach
let element = document.getElementById("myValidationSummary");
let instance = DevExpress.ui.dxValidationSummary.getInstance(element);

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

This UI component's instance.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

jQuery

Handle Events

Angular

Event Handling

Vue

Event Handling

React

Event Handling

option()

Gets all UI component properties.

Return Value:

The UI component's properties.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

option(options)

Updates the values of several properties.

Parameters:

options:

Options with their new values.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

refreshValidationGroup()

Resubscribes the ValidationSummary to a target ValidationGroup.

Use this method if target ValidationGroup is recreated.

jQuery

index.html

index.js

<div id="container"></div>
<div id="summary"></div>
<div id="validate-group"></div>
<div id="remove-group"></div>
<div id="render-group"></div>

$(function() {

    function renderGroup() {
        $("#container").append(
            $("<div></div>").dxTextBox({}) 
            .dxValidator({
                validationRules: [{ type: 'required' }],
                validationGroup: "group"
            }),
            // Initialize other ValidationGroup members
        );
    }

    renderGroup();

    const summary = $("#summary").dxValidationSummary({
        validationGroup: "group"
    }).dxValidationSummary('instance');

    $("#validate-group").dxButton({
        text: "Validate",
        validationGroup: "group",
        onClick: function(e) {
            e.validationGroup.validate();
        }
    });

    $("#remove-group").dxButton({
        text: "Remove group",
        onClick: function() {
            $("#container").empty();
        }
    });

    $("#render-group").dxButton({
        text: "Render group",
        onClick: function() {
            renderGroup();
            summary.refreshValidationGroup(); // Refresh the subscription to ValidationGroup after rendering
        }
    });

});

Angular

app.component.html

app.component.ts

<dx-validation-group #group>
    <dx-text-box *ngIf="visible">
        <dx-validator>
            <dxi-validation-rule type="required" />
        </dx-validator>
    </dx-text-box>
    <!-- Initialize other ValidationGroup members -->
    <dx-validation-summary #summary />
</dx-validation-group>
<dx-button
    text="Validate"
    (onClick)="validate()"
>
</dx-button>
<dx-button
    text="Remove group"
    (onClick)="removeGroup()"
>
</dx-button>
<dx-button
    text="Render group"
    (onClick)="renderGroup()"
>
</dx-button>

import { Component, ViewChild } from '@angular/core';
import { DxValidationGroupComponent, DxValidationSummaryComponent } from 'devextreme-angular';

//...

export class AppComponent {
    @ViewChild('group', {static: false}) validationGroup!: DxValidationGroupComponent
    @ViewChild('summary', {static: false}) summary!: DxValidationSummaryComponent
    visible: boolean = true;
    removeGroup() {
        this.visible = false;
    }
    renderGroup() {
        this.visible = true;
        this.summary.instance.refreshValidationGroup(); // Refresh the subscription to ValidationGroup after rendering
    }
    validate() {
        this.validationGroup.instance.validate();
    }
}

Vue

App.vue

<template>
    <div id="container">
        <DxValidationGroup
            :ref="groupRefKey"
        >
            <DxTextBox v-if="visible">
                <DxValidator>
                    <DxRequiredRule />
                </DxValidator>
            </DxTextBox>
            <!-- Initialize other ValidationGroup members -->
            <DxValidationSummary 
                :ref="summaryRefKey"
            />
        </DxValidationGroup>
        <DxButton
            text="Validate"
            @click="validate"
        />
        <DxButton
            text="Remove group"
            @click="removeGroup"
        />
        <DxButton
            text="Render group"
            @click="renderGroup"
        />
    </div>
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                groupRefKey: 'group',
                summaryRefKey: 'summary',
                visible: true
            }
        },
        methods: {
            validate() {
                this.validationGroup.validate();
            },
            removeGroup() {
                this.visible = false;
            },
            renderGroup() {
                this.visible = true;
                this.summary.refreshValidationGroup(); // Refresh the subscription to ValidationGroup after rendering
            }
        },
        computed: {
            validationGroup() {
                return this.$refs[this.groupRefKey].instance;
            },
            summary() {
                return this.$refs[this.summaryRefKey].instance;
            }
        }
    }
</script>

React

App.js

// ...

function App() {
    const [visible, setVisible] = useState(true);
    const validationGroup = React.createRef();
    const summary = React.createRef();
    const validate = () => {
        validationGroup.current.instance.validate();
    };
    const removeGroup = () => {
        setVisible(false);
    }
    const renderGroup = () => {
        setVisible(true);
        summary.current.instance.refreshValidationGroup(); // Refresh the subscription to ValidationGroup after rendering
    }
    return (
        <div>
            <ValidationGroup
                ref={validationGroup}
            >
                { visible && <div>
                    <TextBox>
                        <Validator>
                            <RequiredRule />
                        </Validator>
                    </TextBox>
                    {/* Initialize other ValidationGroup members */}
                </div> }
                <ValidationSummary 
                    ref={summary}
                />
            </ValidationGroup>
            <Button
                text="Validate"
                onClick={validate}
            />
            <Button
                text="Remove group"
                onClick={removeGroup}
            />
            <Button
                text="Render group"
                onClick={renderGroup}
            />
        </div>
    );
}

export default App;

repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.

The method repaints Toolbar and re-initializes all its items.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

resetOption(optionName)

Resets a property to its default value.

Parameters:

optionName: