Toolbar Default Item Template

This section lists the data source fields that are used in a default template for toolbar items.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also

disabled

Specifies whether or not a widget item must be displayed disabled.

Type: Boolean
Default Value: false

html

Specifies html code inserted into the widget item element.

Type: String

location

Specifies a location for the item on the toolbar.

Type: String
Default Value: 'center'
Accepted Values: 'before'|'after'|'center'|'menu'

Whatever template you use for widget items (default or a custom) will be located according to the value specified for the location field in the item data source object.

See Also

If 'menu' is set as the location field's value, the toolbar item is added to the toolbar's overflow menu. This menu is displayed by a drop-down menu, or the dxPopover, dxActionSheet, application bar widget based on the device on which the application is running. You can introduce a custom template for menu items using the menuItemTemplate option.

options

Specifies a configuration object for the widget that presents a toolbar item.

Type: Object

This data source field is used by a default item template. If you use the default template for your widget items, and specify the widget field in the toolbar data source, you can specify the options field as well. Set the configuration options that are exposed by the configuration object of the specified widget.

See Also

template

Specifies an item template that should be used to render this item only.

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery
A template name or a template container.

Whether you use a default or a custom template for widget items, you can specify a specific template for a particular item. To do so, set the template field for the data source object of this item. The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

text

Specifies text displayed for the widget item.

Type: String

visible

Specifies whether or not a widget item must be displayed.

Type: Boolean
Default Value: true

widget

A widget that presents a toolbar item.

Type: String
Accepted Values: 'button'|'tabs'

This data source field is used by a default default item template. If you use the default template for your widget items, you can specify the widget field in the data source to specify the widget by which a toolbar item must be displayed. Set the configuration options that are exposed by the configuration object of the specified widget. For this purpose, specify the options field in the data source.

See Also