Class ToolbarItem

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

ToolbarItem

Namespace: Syncfusion.EJ2.Navigations

Assembly: Syncfusion.EJ2.dll

Syntax

public class ToolbarItem : EJTagHelper

Constructors

ToolbarItem()

Declaration

public ToolbarItem()

Properties

Align

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 ItemAlign Align { get; set; }

Property Value

Type	Description
ItemAlign	The default value is ItemAlign.Left

Click

Declaration

public string Click { get; set; }

Property Value

Type	Description
System.String	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

CssClass

Defines single/multiple classes (separated by space) to be used for customization of commands.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Disabled

Specifies whether an item should be disabled or not.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

HtmlAttributes

Defines htmlAttributes used to add custom attributes to Toolbar command. Supports HTML attributes such as style, class, etc.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Id

Specifies the unique ID to be used with button or input element of Toolbar items.

Declaration

public override string Id { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Overrides

Syncfusion.EJ2.EJTagHelper.Id

Overflow

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 OverflowOption Overflow { get; set; }

Property Value

Type	Description
OverflowOption	The default value is OverflowOption.None

PrefixIcon

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 string PrefixIcon { get; set; }

Property Value

Type	Description
System.String	The default value is ""

ShowAlwaysInPopup

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 bool ShowAlwaysInPopup { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ShowTextOn

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 DisplayMode ShowTextOn { get; set; }

Property Value

Type	Description
DisplayMode	The default value is DisplayMode.Both

SuffixIcon

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 string SuffixIcon { get; set; }

Property Value

Type	Description
System.String	The default value is ""

TabIndex

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 double TabIndex { get; set; }

Property Value

Type	Description
System.Double	The default value is -1

Template

Specifies the HTML element/element ID as a string that can be added as a Toolbar command.

Declaration

public string Template { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Text

Specifies the text to be displayed on the Toolbar button.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The default value is ""

TooltipText

Specifies the text to be displayed on hovering the Toolbar button.

Declaration

public string TooltipText { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Type

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 ItemType Type { get; set; }

Property Value

Type	Description
ItemType	The default value is ItemType.Button

Visible

Specifies whether an item should be hidden or not.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Width

Specifies the width of the Toolbar button commands.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"