Command Configuration

This section describes configuration options used to create a command.

action

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

Type: Action
Default Value: null

disabled

Indicates whether or not the widget that displays this command is disabled.

Type: Boolean
Default Value: false

icon

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

Type: String
Default Value: ""

This option can take on the name of an icon from the built-in icon library.

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

Setting this option is mandatory, since a command identifier is required when defining an application's command mapping. The identifier should be unique throughout the entire application.

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