Methods

This section describes members used to manipulate the widget.

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.

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"
    }
});

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.

goToItem(itemIndex, animation)

Shows the specified gallery item.

Parameters:
itemIndex: Number
An index of the required gallery item.
animation: Boolean
A Boolean value indicating whether or not to use animation when switching to the required item.
Return Value: jQuery.Promise
A deferred object resolved after the gallery item has changed.

Show Example:
jQuery

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

nextItem(animation)

Shows the next gallery item.

Parameters:
animation: Boolean
A Boolean value indicating whether or not to use animation when switching to the next item.
Return Value: jQuery.Promise
A deferred object resolved after the gallery item has changed.

If the current item is the last item in the gallery, the method behavior depends on the loop option value. If loop is set to true, the first item is shown. Otherwise, the method does nothing.

Show Example:
jQuery

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

prevItem(animation)

Shows the previous gallery item.

Parameters:
animation: Boolean
A Boolean value indicating whether or not to use animation when switching to the previous item.
Return Value: jQuery.Promise
A deferred object resolved after the gallery item has changed.

If the current item is the first item in the gallery, the method behavior depends on the loop option value. If loop is set to true, the last item is shown. Otherwise, the method does nothing.

Show Example:
jQuery

repaint()

Redraws the widget.

After performing some external modifications that lead to a change of the widget container's size or visibility, the widget's state may become invalid. In this instance, use the repaint() method to redraw the widget.