Class ScheduleToolbarItemBuilder

Inheritance

System.Object

Syncfusion.EJ2.ControlBuilder

ScheduleToolbarItemBuilder

Namespace: Syncfusion.EJ2.Schedule

Assembly: Syncfusion.EJ2.dll

Syntax

public class ScheduleToolbarItemBuilder : ControlBuilder

Constructors

ScheduleToolbarItemBuilder()

Declaration

public ScheduleToolbarItemBuilder()

ScheduleToolbarItemBuilder(List<ScheduleToolbarItem>)

Declaration

public ScheduleToolbarItemBuilder(List<ScheduleToolbarItem> collection)

Parameters

Type	Name	Description
System.Collections.Generic.List<ScheduleToolbarItem>	collection

Methods

Add()

Declaration

public void Add()

Align(ItemAlign)

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 ScheduleToolbarItemBuilder Align(ItemAlign align)

Parameters

Type	Name	Description
ItemAlign	align

Returns

Type
ScheduleToolbarItemBuilder

Click(String)

Event triggers when click the toolbar item.

Declaration

public ScheduleToolbarItemBuilder Click(string click)

Parameters

Type	Name	Description
System.String	click

Returns

Type
ScheduleToolbarItemBuilder

CssClass(String)

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

Declaration

public ScheduleToolbarItemBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type
ScheduleToolbarItemBuilder

Disabled(Boolean)

Specifies whether an item should be disabled or not.

Declaration

public ScheduleToolbarItemBuilder Disabled(bool disabled)

Parameters

Type	Name	Description
System.Boolean	disabled

Returns

Type
ScheduleToolbarItemBuilder

HtmlAttributes(Object)

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

Declaration

public ScheduleToolbarItemBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type
ScheduleToolbarItemBuilder

Id(String)

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

Declaration

public ScheduleToolbarItemBuilder Id(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type
ScheduleToolbarItemBuilder

Name(ToolbarName)

Specifies the unique name for each toolbar item rendered in Schedule. This name is used to map the toolbar items in the Schedule component.

Declaration

public ScheduleToolbarItemBuilder Name(ToolbarName name)

Parameters

Type	Name	Description
ToolbarName	name

Returns

Type
ScheduleToolbarItemBuilder

Overflow(OverflowOption)

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 ScheduleToolbarItemBuilder Overflow(OverflowOption overflow)

Parameters

Type	Name	Description
OverflowOption	overflow

Returns

Type
ScheduleToolbarItemBuilder

PrefixIcon(String)

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 ScheduleToolbarItemBuilder PrefixIcon(string prefixIcon)

Parameters

Type	Name	Description
System.String	prefixIcon

Returns

Type
ScheduleToolbarItemBuilder

ShowAlwaysInPopup(Boolean)

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 ScheduleToolbarItemBuilder ShowAlwaysInPopup(bool showAlwaysInPopup)

Parameters

Type	Name	Description
System.Boolean	showAlwaysInPopup

Returns

Type
ScheduleToolbarItemBuilder

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 ScheduleToolbarItemBuilder ShowTextOn(DisplayMode showTextOn)

Parameters

Type	Name	Description
DisplayMode	showTextOn

Returns

Type
ScheduleToolbarItemBuilder

SuffixIcon(String)

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 ScheduleToolbarItemBuilder SuffixIcon(string suffixIcon)

Parameters

Type	Name	Description
System.String	suffixIcon

Returns

Type
ScheduleToolbarItemBuilder

TabIndex(Double)

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 ScheduleToolbarItemBuilder TabIndex(double tabIndex)

Parameters

Type	Name	Description
System.Double	tabIndex

Returns

Type
ScheduleToolbarItemBuilder

Template(String)

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

Declaration

public ScheduleToolbarItemBuilder Template(string template)

Parameters

Type	Name	Description
System.String	template

Returns

Type
ScheduleToolbarItemBuilder

Text(String)

Specifies the text to be displayed on the Toolbar button.

Declaration

public ScheduleToolbarItemBuilder Text(string text)

Parameters

Type	Name	Description
System.String	text

Returns

Type
ScheduleToolbarItemBuilder

TooltipText(String)

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

Declaration

public ScheduleToolbarItemBuilder TooltipText(string tooltipText)

Parameters

Type	Name	Description
System.String	tooltipText

Returns

Type
ScheduleToolbarItemBuilder

Type(ItemType)

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 ScheduleToolbarItemBuilder Type(ItemType type)

Parameters

Type	Name	Description
ItemType	type

Returns

Type
ScheduleToolbarItemBuilder

Visible(Boolean)

Specifies whether an item should be hidden or not.

Declaration

public ScheduleToolbarItemBuilder Visible(bool visible)

Parameters

Type	Name	Description
System.Boolean	visible

Returns

Type
ScheduleToolbarItemBuilder

Width(Double)

Specifies the width of the Toolbar button commands.

Declaration

public ScheduleToolbarItemBuilder Width(double width)

Parameters

Type	Name	Description
System.Double	width

Returns

Type
ScheduleToolbarItemBuilder

Width(String)

Specifies the width of the Toolbar button commands.

Declaration

public ScheduleToolbarItemBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type
ScheduleToolbarItemBuilder