Command Configuration

This section describes configuration options used to create a command.

action

Defines an action performed when the execute() method of the command is called.

Type: String| function |Object
Default Value: null

icon

Specifies the name of the icon shown inside the widget associated with this command.

Type: String
Default Value: ""

iconSrc

A URL pointing to the icon shown inside the widget associated with this command.

Type: String
Default Value: ""

id

The identifier of the command.

Type: String
Default Value: null

The identifier should be unique throughout the entire application.

location

Specifies the logical UI-agnostic location of the command.

Type: String
Default Value: ""

The value should be the location name specified in application layouts by means of the dxCommandContainer markup options.

title

Specifies the title of the widget associated with this command.

Type: String
Default Value: ""

type

Specifies the type of the button, if the command is rendered as a dxButton widget.

Type: String
Default Value: undefined

See the dxButton's type option description for information on accepted values.

visible

A Boolean value specifying whether or not the widget associated with this command is visible.

Type: Boolean
Default Value: true