JavaScript/jQuery Validator Methods

This section describes members used to manipulate the widget.

dispose()

Disposes of all the resources allocated to the Validator instance.

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

jQuery
JavaScript
$("#myValidator").dxValidator("dispose");
$("#myValidator").remove();
Angular
HTML
<dx-validator #validatorVar id="myValidator"></dx-validator>
TypeScript
import { ..., ViewChild } from "@angular/core";
import { DxValidatorComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("validatorVar") validator: DxValidatorComponent;

    removeValidator (e) {
        this.validator.instance.dispose();
        document.getElementById("myValidator").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

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

See Also

focus()

Sets focus to the editor associated with the current Validator object.

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 Validator instance found in an element with the myValidator ID:

// Modular approach
import Validator from 'devextreme/ui/validator';
...
let element = document.getElementById("myValidator");
let instance = Validator.getInstance(element) as Validator;

// Non-modular approach
let element = document.getElementById("myValidator");
let instance = DevExpress.ui.dxValidator.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 editor associated with the current Validator object.

Use this method to "refresh" the editor controlled by the current Validator object. As a result, the editor's value becomes undefined, without validation errors, as it was before validating the editor.

validate()

Validates the value of the editor that is controlled by the current Validator object against the list of the specified validation rules.

Return Value:

Object

The validation result.

The object returned by the validate() function has the following structure.

  • isValid
    Indicates whether all the rules checked for the validator are satisfied.
  • brokenRule
    The broken rule. The structure of the rule object is described in the validation Rules section.
  • validator
    The current Validator widget.
  • value
    The current editor value.
  • validationRules
    An array of validation rules specified for the current validator. The structure of a rule object is described in the validation Rules section.