Vue ValidationGroup Methods

This section describes members used to manipulate the widget.

dispose()

Disposes of all the resources allocated to the ValidationGroup instance.

The following code disposes of an ValidationGroup instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery
JavaScript
$("#myValidationGroup").dxValidationGroup("dispose");
$("#myValidationGroup").remove();
Angular
HTML
<dx-validation-group #validationGroupVar id="myValidationGroup"></dx-validation-group>
TypeScript
import { ..., ViewChild } from "@angular/core";
import { DxValidationGroupComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("validationGroupVar") validationGroup: DxValidationGroupComponent;

    removeValidationGroup (e) {
        this.validationGroup.instance.dispose();
        document.getElementById("myValidationGroup").remove();
    }
}

element()

Gets the root widget 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 widget found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget 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 widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Object

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:

Object

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:

Object

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:

Object

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 widget options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

See Also

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

See Also

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with 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.

validate()

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

Return Value:

Object

The current group's validation result.

The returned object contains the following fields:

  • isValid: Boolean
    Indicates whether all the rules checked for the group are satisfied.

  • brokenRules: Array
    Rules that failed to pass the check. Their structure is described in the Validation Rules section.

  • validators: Array
    Validator widgets included in the validated group.

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