JavaScript/jQuery 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
component
An alias for the template option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
locateInMenu
Specifies when to display an item in the toolbar's overflow menu.
Use the ToolbarItemLocateInMenuMode
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Always
, Never
, and Auto
.
location
Specifies a location for the item on the toolbar.
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.
Use the ToolbarItemLocation
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Before
, After
, and Center
.
See Also
menuItemComponent
An alias for the menuItemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
menuItemRender
An alias for the menuItemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
menuItemTemplate
Specifies a template that should be used to render a menu item.
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.
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
render
An alias for the template option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
showText
Specifies when to display the text for the widget item.
The text should be specified in the options configuration object.
Use the ToolbarItemShowTextMode
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Always
and InMenu
.
template
Specifies an item template that should be used to render this item only.
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
widget
A widget that presents a toolbar item.
When using ASP.NET MVC 5 Controls or DevExtreme-Based ASP.NET Core Controls, configure this option with a lambda expression as follows:
@(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
If you have technical questions, please create a support ticket in the DevExpress Support Center.