JavaScript/jQuery ValidationGroup Methods

This section describes members used to manipulate the UI component.

See Also

dispose()

Disposes of all the resources allocated to the ValidationGroup instance.

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

JavaScript
$("#myValidationGroup").dxValidationGroup("dispose");
$("#myValidationGroup").remove();

Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-validation-group ...
    *ngIf="condition">
</dx-validation-group>
Vue
App.vue
<template>
    <DxValidationGroup ...
        v-if="condition">
    </DxValidationGroup>
</template>

<script>
import DxValidationGroup from 'devextreme-vue/validation-group';

export default {
    components: {
        DxValidationGroup
    }
}
</script>
React
App.js
import React from 'react';

import ValidationGroup from 'devextreme-react/validation-group';

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

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

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

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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

See Also

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:

Object

The UI component's instance.

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

// Modular approach
import ValidationGroup from "devextreme/ui/validation_group";
...
let element = document.getElementById("myValidationGroup");
let instance = ValidationGroup.getInstance(element) as ValidationGroup;

// Non-modular approach
let element = document.getElementById("myValidationGroup");
let instance = DevExpress.ui.dxValidationGroup.getInstance(element);
See Also

instance()

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

Return Value:

ValidationGroup

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

ValidationGroup

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

ValidationGroup

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

ValidationGroup

The object for which this method is called.

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

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

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

Return Value:

ValidationGroup

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.

See Also

option()

Gets all UI component properties.

Return Value:

Object

The UI component's properties.

See Also

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

See Also

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

See Also

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Propertieswith their new values.

See Also

reset()

Resets the value and validation result of the editors that are included to the current validation group.

This method calls the reset method of each Validator object included to the current validation group.

resetOption(optionName)

Resets an property to its default value.

Parameters:
optionName:

String

An property's name.

See Also

validate()

Validates rules of the validators that belong to the current validation group.

Return Value:

dxValidationGroupResult

The current group's validation result.

As an alternative to this method, you can use the DevExpress.validationEngine.validateGroup(group) function passing the current group as a parameter.