Angular Validator Methods

This section describes members used to manipulate the UI component.

See Also

dispose()

Disposes of all the resources allocated to the Validator instance.

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

JavaScript
$("#myValidator").dxValidator("dispose");
$("#myValidator").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-validator ...
    *ngIf="condition">
</dx-validator>
Vue
App.vue
<template>
    <DxValidator ...
        v-if="condition">
    </DxValidator>
</template>

<script>
import DxValidator from 'devextreme-vue/validator';

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

import Validator from 'devextreme-react/validator';

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

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

class App extends React.Component {
    render() {
        return (
            <DxValidator 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

focus()

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

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 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 UI component's instance. Use it to access other methods of the UI component.

Return Value:

Validator

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:

Validator

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:

Validator

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:

Validator

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:

Validator

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

Options with their new values.

See Also

reset()

Resets the value and validation result of the editor associated with the current Validator object.

resetOption(optionName)

Resets a property to its default value.

Parameters:
optionName:

String

A property's name.

See Also

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:

dxValidatorResult

The validation result.