Class ToolbarItemBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ToolbarItemBuilder
Assembly: Syncfusion.EJ2.dll
public class ToolbarItemBuilder : ControlBuilder
Constructors
Declaration
public ToolbarItemBuilder()
Declaration
public ToolbarItemBuilder(List<ToolbarItem> collection)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<ToolbarItem> |
collection |
|
Methods
Declaration
Specifies the location for aligning Toolbar items on the Toolbar. Each command will be aligned according to the align
property.
The possible values for this property as follows
Left
: To align commands to the left side of the Toolbar.
Center
: To align commands at the center of the Toolbar.
Right
: To align commands to the right side of the Toolbar.
Declaration
public ToolbarItemBuilder Align(ItemAlign align)
Parameters
Returns
Event triggers when click
the toolbar item.
Declaration
public ToolbarItemBuilder Click(string click)
Parameters
Type |
Name |
Description |
System.String |
click |
|
Returns
ContentTemplate(Action<Object>)
Declaration
public ToolbarItemBuilder ContentTemplate(Action<object> template)
Parameters
Type |
Name |
Description |
System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public ToolbarItemBuilder ContentTemplate(Func<object, object> template)
Parameters
Type |
Name |
Description |
System.Func<System.Object, System.Object> |
template |
|
Returns
Defines single/multiple classes (separated by space) to be used for customization of commands.
Declaration
public ToolbarItemBuilder CssClass(string cssClass)
Parameters
Type |
Name |
Description |
System.String |
cssClass |
|
Returns
Specifies whether an item should be disabled or not.
Declaration
public ToolbarItemBuilder Disabled(bool disabled)
Parameters
Type |
Name |
Description |
System.Boolean |
disabled |
|
Returns
Defines htmlAttributes used to add custom attributes to Toolbar command.
Supports HTML attributes such as style, class, etc.
Declaration
public ToolbarItemBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
Specifies the unique ID to be used with button or input element of Toolbar items.
Declaration
public ToolbarItemBuilder Id(string id)
Parameters
Type |
Name |
Description |
System.String |
id |
|
Returns
Specifies the Toolbar command display area when an element's content is too large to fit available space.
This is applicable only to popup
mode. The possible values for this property as follows
Show
: Always shows the item as the primary priority on the Toolbar.
Hide
: Always shows the item as the secondary priority on the popup.
None
: No priority for display, and as per normal order moves to popup when content exceeds.
Declaration
public ToolbarItemBuilder Overflow(OverflowOption overflow)
Parameters
Returns
Defines single/multiple classes separated by space used to specify an icon for the button.
The icon will be positioned before the text content if text is available, otherwise the icon alone will be rendered.
Declaration
public ToolbarItemBuilder PrefixIcon(string prefixIcon)
Parameters
Type |
Name |
Description |
System.String |
prefixIcon |
|
Returns
Defines the priority of items to display it in popup always.
It allows to maintain toolbar item on popup always but it does not work for toolbar priority items.
Declaration
public ToolbarItemBuilder ShowAlwaysInPopup(bool showAlwaysInPopup)
Parameters
Type |
Name |
Description |
System.Boolean |
showAlwaysInPopup |
|
Returns
ShowTextOn(DisplayMode)
Specifies where the button text will be displayed on popup mode of the Toolbar.
The possible values for this property as follows
Toolbar
: Text will be displayed on Toolbar only.
Overflow
: Text will be displayed only when content overflows to popup.
Both
: Text will be displayed on popup and Toolbar.
Declaration
public ToolbarItemBuilder ShowTextOn(DisplayMode showTextOn)
Parameters
Returns
Defines single/multiple classes separated by space used to specify an icon for the button.
The icon will be positioned after the text content if text is available.
Declaration
public ToolbarItemBuilder SuffixIcon(string suffixIcon)
Parameters
Type |
Name |
Description |
System.String |
suffixIcon |
|
Returns
Specifies the tab order of the Toolbar items. When positive values assigned, it allows to switch focus to the next/previous toolbar items with Tab/ShiftTab keys.
By default, user can able to switch between items only via arrow keys.
If the value is set to 0 for all tool bar items, then tab switches based on element order.
Declaration
public ToolbarItemBuilder TabIndex(double tabIndex)
Parameters
Type |
Name |
Description |
System.Double |
tabIndex |
|
Returns
Specifies the HTML element/element ID as a string that can be added as a Toolbar command.
Declaration
public ToolbarItemBuilder Template(string template)
Parameters
Type |
Name |
Description |
System.String |
template |
|
Returns
Text(String)
Specifies the text to be displayed on the Toolbar button.
Declaration
public ToolbarItemBuilder Text(string text)
Parameters
Type |
Name |
Description |
System.String |
text |
|
Returns
TooltipText(String)
Specifies the text to be displayed on hovering the Toolbar button.
Declaration
public ToolbarItemBuilder TooltipText(string tooltipText)
Parameters
Type |
Name |
Description |
System.String |
tooltipText |
|
Returns
Specifies the types of command to be rendered in the Toolbar.
Supported types are:
Button
: Creates the Button control with its given properties like text, prefixIcon, etc.
Separator
: Adds a horizontal line that separates the Toolbar commands.
Input
: Creates an input element that is applicable to template rendering with Syncfusion controls like DropDownList,
AutoComplete, etc.
Declaration
public ToolbarItemBuilder Type(ItemType type)
Parameters
Returns
Specifies whether an item should be hidden or not.
Declaration
public ToolbarItemBuilder Visible(bool visible)
Parameters
Type |
Name |
Description |
System.Boolean |
visible |
|
Returns
Specifies the width of the Toolbar button commands.
Declaration
public ToolbarItemBuilder Width(double width)
Parameters
Type |
Name |
Description |
System.Double |
width |
|
Returns
Specifies the width of the Toolbar button commands.
Declaration
public ToolbarItemBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns