Class ToolbarBuilder
Inheritance
System.Object
ToolbarBuilder
Assembly: Syncfusion.EJ2.dll
public class ToolbarBuilder : ControlBuilder
Constructors
Declaration
Declaration
public ToolbarBuilder(Toolbar model)
Parameters
Type |
Name |
Description |
Toolbar |
model |
|
Fields
Declaration
Field Value
Properties
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.IDictionary<System.String, System.Object> |
|
Declaration
public string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
Description |
System.IO.TextWriter |
|
Overrides
Methods
When this property is set to true, it allows the keyboard interaction in toolbar.
Declaration
public ToolbarBuilder AllowKeyboard(bool allowKeyboard = true)
Parameters
Type |
Name |
Description |
System.Boolean |
allowKeyboard |
|
Returns
The event will be fired before the control is rendered on a page.
Declaration
public ToolbarBuilder BeforeCreate(string beforeCreate)
Parameters
Type |
Name |
Description |
System.String |
beforeCreate |
|
Returns
The event will be fired on clicking the Toolbar elements.
Declaration
public ToolbarBuilder Clicked(string clicked)
Parameters
Type |
Name |
Description |
System.String |
clicked |
|
Returns
ContentTemplate(Action<Object>)
Declaration
public ToolbarBuilder ContentTemplate(Action<object> template)
Parameters
Type |
Name |
Description |
System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public ToolbarBuilder ContentTemplate(Func<object, object> template)
Parameters
Type |
Name |
Description |
System.Func<System.Object, System.Object> |
template |
|
Returns
The event will be fired when the control is rendered.
Declaration
public ToolbarBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
Sets the CSS classes to root element of the Tab that helps to customize component styles.
Declaration
public ToolbarBuilder CssClass(string cssClass)
Parameters
Type |
Name |
Description |
System.String |
cssClass |
|
Returns
The event will be fired when the control gets destroyed.
Declaration
public ToolbarBuilder Destroyed(string destroyed)
Parameters
Type |
Name |
Description |
System.String |
destroyed |
|
Returns
Enable or disable the popup collision.
Declaration
public ToolbarBuilder EnableCollision(bool enableCollision = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableCollision |
|
Returns
Defines whether to allow the cross-scripting site or not.
Declaration
public ToolbarBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableHtmlSanitizer |
|
Returns
Enable or disable persisting component's state between page reloads.
Declaration
public ToolbarBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
Enable or disable rendering component in right to left direction.
Declaration
public ToolbarBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
Specifies the height of the Toolbar in pixels/number/percentage. Number value is considered as pixels.
Declaration
public ToolbarBuilder Height(double height)
Parameters
Type |
Name |
Description |
System.Double |
height |
|
Returns
Specifies the height of the Toolbar in pixels/number/percentage. Number value is considered as pixels.
Declaration
public ToolbarBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public ToolbarBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
Declaration
public ToolbarBuilder Items(Action<ToolbarItemBuilder> items)
Parameters
Returns
An array of items that is used to configure Toolbar commands.
Declaration
public ToolbarBuilder Items(List<ToolbarItem> items)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<ToolbarItem> |
items |
|
Returns
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public ToolbarBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Specifies the Toolbar display mode when Toolbar content exceeds the viewing area.
The possible values for this property as follows
- Scrollable: All the elements are displayed in a single line with horizontal scrolling enabled.
- Popup: Prioritized elements are displayed on the Toolbar and the rest of elements are moved to the popup.
- MultiRow: Displays the overflow toolbar items as an in-line of a toolbar.
- Extended: Hide the overflowing toolbar items in the next row. Show the overflowing toolbar items when you click the expand icons.
If the popup content overflows the height of the page, the rest of the elements will be hidden.
Declaration
public ToolbarBuilder OverflowMode(OverflowMode overflowMode)
Parameters
Returns
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
Specifies the scrolling distance in scroller.
The possible values for this property as follows
Scrollable - All the elements are displayed in a single line with horizontal scrolling enabled.
Popup - Prioritized elements are displayed on the Toolbar and the rest of elements are moved to the popup.
MultiRow - Displays the overflow toolbar items as an in-line of a toolbar.
Extended - Hide the overflowing toolbar items in the next row. Show the overflowing toolbar items when you click the expand icons.
If the popup content overflows the height of the page, the rest of the elements will be hidden.
Declaration
public ToolbarBuilder ScrollStep(double scrollStep)
Parameters
Type |
Name |
Description |
System.Double |
scrollStep |
|
Returns
Specifies the width of the Toolbar in pixels/numbers/percentage. Number value is considered as pixels.
Declaration
public ToolbarBuilder Width(double width)
Parameters
Type |
Name |
Description |
System.Double |
width |
|
Returns
Specifies the width of the Toolbar in pixels/numbers/percentage. Number value is considered as pixels.
Declaration
public ToolbarBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns