Class ToolbarPropertiesBuilder

Inheritance

System.Object

ToolbarPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class ToolbarPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

ToolbarPropertiesBuilder()

Initializes a new instance of the ToolbarPropertiesBuilder class.

Declaration

public ToolbarPropertiesBuilder()

ToolbarPropertiesBuilder(Toolbar)

Initializes a new instance of the ToolbarPropertiesBuilder class.

Declaration

public ToolbarPropertiesBuilder(Toolbar toolbar)

Parameters

Type	Name	Description
Toolbar	toolbar	Accepts the Toolbar properties

Fields

toolbar

Creates a new instance of the Toolbar class.

Declaration

public Toolbar toolbar

Field Value

Type	Description
Toolbar

Properties

ItemsCollection

Gets or sets the Toolbar items collection

Declaration

public List<ToolbarBaseItem> ItemsCollection { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ToolbarBaseItem>

Methods

ClientSideEvents(Action<ToolbarClientSideEventsBuilder>)

Toolbar client side events.

Declaration

public ToolbarPropertiesBuilder ClientSideEvents(Action<ToolbarClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<ToolbarClientSideEventsBuilder>	clientSideEvents	clientSideEvents

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns toolbar properties builder value

CssClass(String)

Sets the root CSS class for Toolbar control to achieve the custom theme.

Declaration

public ToolbarPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns string value

Datasource(DataSource)

Specifies dataSource value for the Toolbar control during initialization.A variable dataSource is passed.

Declaration

public ToolbarPropertiesBuilder Datasource(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource	dataSource

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns toolbar properties builder value

Datasource(Action<DataSourceBuilder>)

Specifies dataSource value for the Toolbar control during initialization.

Declaration

public ToolbarPropertiesBuilder Datasource(Action<DataSourceBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	dataSource	dataSource

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns toolbar properties builder value

Datasource(IEnumerable)

Specifies dataSource value for the Toolbar control during initialization.A variable dataSource is passed in IEnumerable type.

Declaration

public ToolbarPropertiesBuilder Datasource(IEnumerable dataSource)

Parameters

Type	Name	Description
System.Collections.IEnumerable	dataSource	dataSource

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns toolbar properties builder value

DisabledItemIndices(List<Int32>)

Disables the given items

Declaration

public ToolbarPropertiesBuilder DisabledItemIndices(List<int> disabledItemIndices)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	disabledItemIndices	disabled item index

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns array value

Enabled()

Specifies the Toolbar control state.

Declaration

public ToolbarPropertiesBuilder Enabled()

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

Enabled(Boolean)

Specifies the Toolbar control state.A boolean variable enabled is passed.

Declaration

public ToolbarPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

EnabledItemIndices(List<Int32>)

Enables the given items

Declaration

public ToolbarPropertiesBuilder EnabledItemIndices(List<int> enabledItemIndices)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	enabledItemIndices	enable item index

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns array value

EnableRTL()

Specifies enableRTL property to align the Toolbar control from right to left direction.

Declaration

public ToolbarPropertiesBuilder EnableRTL()

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

EnableRTL(Boolean)

Specifies enableRTL property to align the Toolbar control from right to left direction.A boolean variable enableRTL is passed.

Declaration

public ToolbarPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

EnableSeparator()

Allows to separate the each UL items in the Toolbar control.

Declaration

public ToolbarPropertiesBuilder EnableSeparator()

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

EnableSeparator(Boolean)

Specifies to hide a pane of Tab control.

Declaration

public ToolbarPropertiesBuilder EnableSeparator(bool enableSeparator)

Parameters

Type	Name	Description
System.Boolean	enableSeparator	enableSeparator

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

Height(String)

Specifies the height of the Toolbar.

Declaration

public ToolbarPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns string value

Hide()

Specifies whether the Toolbar control is need to be show or hide.

Declaration

public ToolbarPropertiesBuilder Hide()

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

Hide(Boolean)

Specifies whether the Toolbar control is need to be show or hide.A boolean variable hide is passed.

Declaration

public ToolbarPropertiesBuilder Hide(bool hide)

Parameters

Type	Name	Description
System.Boolean	hide	hide

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

HtmlAttributes(IDictionary<String, Object>)

Specifies the list of html attributes to be added to Toolbar control.

Declaration

public ToolbarPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	html Attributes

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns object value

IsResponsive()

Enables/Disables the responsive support for Toolbar items during the window resizing time.

Declaration

public ToolbarPropertiesBuilder IsResponsive()

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

IsResponsive(Boolean)

Enables/Disables the responsive support for Toolbar items during the window resizing time.A boolean variable isResponsive is passed.

Declaration

public ToolbarPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive	isResponsive

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

Items(Action<ToolbarBaseItemAdder>)

Specifies the toolbar items

Declaration

public ToolbarPropertiesBuilder Items(Action<ToolbarBaseItemAdder> items)

Parameters

Type	Name	Description
System.Action<ToolbarBaseItemAdder>	items	items

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns toolbar properties builder value

Orientation(Orientation)

Specifies the Toolbar orientation.

Declaration

public ToolbarPropertiesBuilder Orientation(Orientation orientation)

Parameters

Type	Name	Description
Orientation	orientation	orientation

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns enum|string value

Query(String)

Specifies the query to retrieve the data from the online server. The query is used only when the online dataSource is used.

Declaration

public ToolbarPropertiesBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query	query

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns object value

Render()

Renders this instance.

Declaration

public void Render()

ResponsiveType(ResponsiveType)

Specifies the Toolbar responsiveType.

Declaration

public ToolbarPropertiesBuilder ResponsiveType(ResponsiveType responsiveType)

Parameters

Type	Name	Description
ResponsiveType	responsiveType	responsiveType

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns enum|string value

ShowRoundedCorner()

Displays the Toolbar with rounded corners.

Declaration

public ToolbarPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

ShowRoundedCorner(Boolean)

Displays the Toolbar with rounded corners.A boolean variable showRoundedCorner is passed.

Declaration

public ToolbarPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner	showRoundedCorner

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns boolean value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

ToolbarFields(Action<ToolbarFieldsBuilder>)

Specifies the mapping fields for the data items of the Toolbar.

Declaration

public ToolbarPropertiesBuilder ToolbarFields(Action<ToolbarFieldsBuilder> fields)

Parameters

Type	Name	Description
System.Action<ToolbarFieldsBuilder>	fields	fields

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns toolbar properties builder value

TooltipSettings(Action<TooltipPropertiesBuilder>)

Sets the tooltipSettings in the Toolbar.

Declaration

public ToolbarPropertiesBuilder TooltipSettings(Action<TooltipPropertiesBuilder> tooltipSettings)

Parameters

Type	Name	Description
System.Action<TooltipPropertiesBuilder>	tooltipSettings	tooltipSettings

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns object value

Width(String)

Specifies the width of the Toolbar.

Declaration

public ToolbarPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
ToolbarPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString