Methods

This section describes members used to manipulate a widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:
rule: Object

An object specifying default options for the component and the device for which the options must be applied.

Object structure:
device: Object|Array|function

An object representing device parameters, or an array of objects representing device parameters, or a function that provides information on the current device as an input parameter and returning a Boolean value.

options: Object

A configuration object with specified options.

The defaultOptions method is a static method supported by the widget class. The following code demonstrates how to specify default options for all buttons in the application executed on the iOS platform.

JavaScript
DevExpress.ui.dxButton.defaultOptions({ 
    device: { platform: "ios" },
    options: {
        text: "Click me"
    }
});

element()

Gets the root element of the widget.

Return Value: jQuery

The root element of the widget.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

focus()

Sets focus on the widget.

See Also

getEditor(field)

Returns an editor instance associated with the specified formData field or name of the form item.

Parameters:
field: String

The path to the required formData field or name of the form item.

Return Value: any

An instance of the required editor.

NOTE
The method returns an editor instance only if a form item is visible.
See Also

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value: Object

This widget's instance.

See Also

itemOption(field)

Gets the value of the form item option.

Parameters:
field: String

Specifies the path to the required formData field, or the name of the required item.

Return Value: any

The value of an item option.

If the required item is contained in a group or tabbed item, add the group or tab title followed by a dot before the required item name and pass this value to the field argument.

JavaScript
$("#myForm").dxForm("instance").itemOption("MyGroup.MyItem");
See Also

itemOption(field, option, value)

Updates the value of a form item option.

Parameters:
field: String

Specifies the path to the required formData field, or the name of the required editor.

option: String

The name of the option to be updated.

value: any

The new option value.

If the required item is contained in a group or tabbed item, add the group or tab title followed by a dot before the required item name and pass this value to the field argument.

JavaScript
$("#myForm").dxForm("instance").itemOption("MyGroup.MyItem", "visible", false);
See Also

itemOption(field, options)

Updates the values of form item options.

Parameters:
field: String

Specifies the path to the required formData field, or the name of the required item.

options: Object

A configuration object containing options to be updated and their values.

Use this method to update several options of a form item.

If the required item is contained in a group or tabbed item, add the group or tab title followed by a dot before the required item name and pass this value to the field argument.

JavaScript
$("#myForm").dxForm("instance").itemOption("MyGroup.MyItem", {. . .});
See Also

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String

The name of the event to unsubscribe from.

Return Value: Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String

The name of the event to unsubscribe from.

eventHandler: function

The handler to be detached from the specified event.

Return Value: Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String

The name of the event to be subscribed.

eventHandler: function

An event handler for the specified event.

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 the specified events.

Parameters:
events: Object

An object of the following structure: { "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 the widget's options.

Return Value: Object

The widget's options.

See Also

option(optionName)

Gets a specific option value.

Parameters:
optionName: String

The option name or the full path to the option.

Return Value: any

This option value.

See Also

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName: String

The option name or the full path to the option.

optionValue: any

A new value for this option.

See Also

option(options)

Sets one or more options.

Parameters:
options: Object

The options along with their new values.

See Also

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:
key: String

The key for which the handler should be registered.

handler: function

A handler.

The key argument accepts one of the following values:

  • "backspace"
  • "tab"
  • "enter"
  • "escape"
  • "pageUp"
  • "pageDown"
  • "end"
  • "home"
  • "leftArrow"
  • "upArrow"
  • "rightArrow"
  • "downArrow"
  • "del"
  • "space"
  • "F"
  • "A"
  • "asterisk"
  • "minus"

A custom handler for a key cancels the default handler for this key.

See Also
Show Example:
jQuery

repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

See Also

resetValues()

Resets the editor's value to undefined.

See Also

updateData(data)

Updates the specified fields of the formData object and the corresponding editors on the form.

Parameters:
data: Object

An object containing the fields to be updated and their new values.

See Also

updateData(dataField, value)

Updates the specified field of the formData object and the corresponding editor on the form.

Parameters:
dataField: String

Specifies the path to the required formData field.

value: Object

The new field value.

See Also

updateDimensions()

Updates the dimensions of the widget contents.

Return Value: jQuery.Promise

A promise of the jQuery Deferred object resolved when the update is complete.

Use this method to fit the widget contents to the widget size after it (size) has been changed.

See Also

validate()

Validates the values of all editors on the form against the list of the validation rules specified for each form item.

Return Value: Object

An object defining the result of validation.

See Also
Show Example:
AngularJS
Knockout
jQuery