Class RibbonBuilder

Inheritance

System.Object

ControlBuilder

RibbonBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Ribbon

Assembly: Syncfusion.EJ2.dll

Syntax

public class RibbonBuilder : ControlBuilder

Constructors

RibbonBuilder()

Declaration

public RibbonBuilder()

RibbonBuilder(Ribbon)

Declaration

public RibbonBuilder(Ribbon model)

Parameters

Type	Name	Description
Ribbon	model

Fields

model

Declaration

public Ribbon model

Field Value

Type	Description
Ribbon

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

ActiveLayout(RibbonLayout)

Specifies the active layout of the ribbon. Accepts one of the below values. Classic – Renders the ribbon tab contents in classic layout. Simplified – Renders the ribbon tab contents in single row.

Declaration

public RibbonBuilder ActiveLayout(RibbonLayout activeLayout)

Parameters

Type	Name	Description
RibbonLayout	activeLayout

Returns

Type	Description
RibbonBuilder

BackStageMenu(BackStageMenu)

Defines the properties of ribbon backstage.

Declaration

public RibbonBuilder BackStageMenu(BackStageMenu backStageMenu)

Parameters

Type	Name	Description
BackStageMenu	backStageMenu

Returns

Type	Description
RibbonBuilder

BackStageMenu(Action<BackStageMenuBuilder>)

Declaration

public RibbonBuilder BackStageMenu(Action<BackStageMenuBuilder> backStageMenu)

Parameters

Type	Name	Description
System.Action<BackStageMenuBuilder>	backStageMenu

Returns

Type	Description
RibbonBuilder

ContentTemplate(Action<Object>)

Declaration

public RibbonBuilder ContentTemplate(Action<object> template)

Parameters

Type	Name	Description
System.Action<System.Object>	template

Returns

Type	Description
RibbonBuilder

ContentTemplate(Func<Object, Object>)

Declaration

public RibbonBuilder ContentTemplate(Func<object, object> template)

Parameters

Type	Name	Description
System.Func<System.Object, System.Object>	template

Returns

Type	Description
RibbonBuilder

Created(String)

Event triggers once the Ribbon Component rendering is completed.

Declaration

public RibbonBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
RibbonBuilder

CssClass(String)

Defines one or more CSS classes to customize the appearance of ribbon.

Declaration

public RibbonBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
RibbonBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public RibbonBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
RibbonBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public RibbonBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
RibbonBuilder

FileMenu(FileMenuSettings)

Defines the properties of ribbon file menu.

Declaration

public RibbonBuilder FileMenu(FileMenuSettings fileMenu)

Parameters

Type	Name	Description
FileMenuSettings	fileMenu

Returns

Type	Description
RibbonBuilder

FileMenu(Action<FileMenuSettingsBuilder>)

Declaration

public RibbonBuilder FileMenu(Action<FileMenuSettingsBuilder> fileMenu)

Parameters

Type	Name	Description
System.Action<FileMenuSettingsBuilder>	fileMenu

Returns

Type	Description
RibbonBuilder

HelpPaneTemplate(String)

Specifies the template content for the help pane of ribbon. The help pane appears on the right side of the ribbon header row.

Declaration

public RibbonBuilder HelpPaneTemplate(string helpPaneTemplate)

Parameters

Type	Name	Description
System.String	helpPaneTemplate

Returns

Type	Description
RibbonBuilder

HideLayoutSwitcher(Boolean)

Defines whether to show the layout switcher button or not.

Declaration

public RibbonBuilder HideLayoutSwitcher(bool hideLayoutSwitcher = true)

Parameters

Type	Name	Description
System.Boolean	hideLayoutSwitcher

Returns

Type	Description
RibbonBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public RibbonBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
RibbonBuilder

IsMinimized(Boolean)

Specifies whether the ribbon is minimized or not. When minimized, only the tab header is shown.

Declaration

public RibbonBuilder IsMinimized(bool isMinimized = true)

Parameters

Type	Name	Description
System.Boolean	isMinimized

Returns

Type	Description
RibbonBuilder

LauncherIconClick(String)

Event triggers when the launcher icon of the group is clicked.

Declaration

public RibbonBuilder LauncherIconClick(string launcherIconClick)

Parameters

Type	Name	Description
System.String	launcherIconClick

Returns

Type	Description
RibbonBuilder

LauncherIconCss(String)

Defines the icon CSS for the launcher icon button in group header.

Declaration

public RibbonBuilder LauncherIconCss(string launcherIconCss)

Parameters

Type	Name	Description
System.String	launcherIconCss

Returns

Type	Description
RibbonBuilder

Locale(String)

Provides the localization value for the controls present in ribbon items.

Declaration

public RibbonBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
RibbonBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

RibbonCollapsing(String)

Event triggers before collapsing the ribbon.

Declaration

public RibbonBuilder RibbonCollapsing(string ribbonCollapsing)

Parameters

Type	Name	Description
System.String	ribbonCollapsing

Returns

Type	Description
RibbonBuilder

RibbonExpanding(String)

Event triggers before expanding the ribbon.

Declaration

public RibbonBuilder RibbonExpanding(string ribbonExpanding)

Parameters

Type	Name	Description
System.String	ribbonExpanding

Returns

Type	Description
RibbonBuilder

SelectedTab(Double)

Specifies the index of the current active tab.

Declaration

public RibbonBuilder SelectedTab(double selectedTab)

Parameters

Type	Name	Description
System.Double	selectedTab

Returns

Type	Description
RibbonBuilder

TabAnimation(Object)

Specifies the animation configuration settings for showing the content of the Ribbon Tab.

Declaration

public RibbonBuilder TabAnimation(object tabAnimation)

Parameters

Type	Name	Description
System.Object	tabAnimation

Returns

Type	Description
RibbonBuilder

Tabs(Action<RibbonTabBuilder>)

Declaration

public RibbonBuilder Tabs(Action<RibbonTabBuilder> tabs)

Parameters

Type	Name	Description
System.Action<RibbonTabBuilder>	tabs

Returns

Type	Description
RibbonBuilder

Tabs(List<RibbonTab>)

Defines the list of ribbon tabs.

Declaration

public RibbonBuilder Tabs(List<RibbonTab> tabs)

Parameters

Type	Name	Description
System.Collections.Generic.List<RibbonTab>	tabs

Returns

Type	Description
RibbonBuilder

TabSelected(String)

Event triggers after selecting the tab item.

Declaration

public RibbonBuilder TabSelected(string tabSelected)

Parameters

Type	Name	Description
System.String	tabSelected

Returns

Type	Description
RibbonBuilder

TabSelecting(String)

Event triggers before selecting the tab item.

Declaration

public RibbonBuilder TabSelecting(string tabSelecting)

Parameters

Type	Name	Description
System.String	tabSelecting

Returns

Type	Description
RibbonBuilder

Width(Double)

Specifies the width of the ribbon.

Declaration

public RibbonBuilder Width(double width)

Parameters

Type	Name	Description
System.Double	width

Returns

Type	Description
RibbonBuilder

Width(String)

Specifies the width of the ribbon.

Declaration

public RibbonBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
RibbonBuilder