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

locateInMenu

Specifies when to display an item in the toolbar's overflow menu.

Type:

String

Default Value: 'never'
Accepted Values: 'always' | 'never' | 'auto'

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ToolbarItemLocateInMenuMode enum. This enum accepts the following values: Always, Never and Auto.

location

Specifies a location for the item on the toolbar.

Type:

String

Default Value: 'center'
Accepted Values: 'before' | 'after' | 'center'

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.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ToolbarItemLocation enum. This enum accepts the following values: Before, After and Center.

See Also

menuItemTemplate

Specifies a template that should be used to render a menu item.

Type:

template

Return Value:

String

|

jQuery

A template name or a template container.

Whether you use a default or a custom template for menu items, you can specify a specific template for a particular menu item. To do so, set the menuItemTemplate field for the data source object of this menu 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

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.

NOTE
If you use the Menu widget as a toolbar item, the adaptivityEnabled option does not apply.
See Also

showText

Specifies when to display the text for the widget item.

Type:

String

Default Value: 'always'
Accepted Values: 'always' | 'inMenu'

The text should be specified in the options configuration object.

NOTE
This option is available only for the dxButton widget that presents a toolbar item.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ToolbarItemShowTextMode enum. This enum accepts the following values: Always and InMenu.

template

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

Type:

template

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: 'dxButton' | 'dxTabs' | 'dxCheckBox' | 'dxSelectBox' | 'dxTextBox' | 'dxAutocomplete' | 'dxDateBox' | 'dxMenu' | 'dxDropDownMenu'

This data source field is used by a 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.

NOTE
If you use the Menu widget as a toolbar item, the adaptivityEnabled option does not apply.

When using ASP.NET MVC Wrappers, configure this option with a lambda expression in the following manner.

Razor C#
Razor VB
@(Html.DevExtreme().Toolbar()
    .Items(items => {
        items.Add().Widget(w => w
            // Instead of Button here you can use any other widget
            .Button()
            .Text("Back")
        );
    })
)
@(Html.DevExtreme().Toolbar() _
    .Items(Sub(items)
        items.Add().Widget(Function(w)
            ' Instead of Button here you can use any other widget
            Return w.Button().Text("Back")
        End Function)
    End Sub)
)
See Also