Class Ribbon

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

Ribbon

Namespace: Syncfusion.EJ2.Ribbon

Assembly: Syncfusion.EJ2.dll

Syntax

public class Ribbon : EJTagHelper

Constructors

Ribbon()

Declaration

public Ribbon()

Properties

ActiveLayout

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 RibbonLayout ActiveLayout { get; set; }

Property Value

Type	Description
RibbonLayout	The default value is RibbonLayout.Classic

BackStageMenu

Defines the properties of ribbon backstage.

Declaration

public BackStageMenu BackStageMenu { get; set; }

Property Value

Type	Description
BackStageMenu	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>

ContextualTabs

Defines the properties of ribbon contextual tab.

Declaration

public List<RibbonContextualTab> ContextualTabs { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<Syncfusion.EJ2.Ribbon.RibbonContextualTab>	The default value is null

Created

Event triggers once the Ribbon Component rendering is completed.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

CssClass

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

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is ""

EnableKeyTips

Defines whether to enable the key tip or not.

Declaration

public bool EnableKeyTips { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePersistence

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

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

FileMenu

Defines the properties of ribbon file menu.

Declaration

public FileMenuSettings FileMenu { get; set; }

Property Value

Type	Description
FileMenuSettings	The default value is null

HelpPaneTemplate

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

Property Value

Type	Description
System.String	The default value is ""

HideLayoutSwitcher

Defines whether to show the layout switcher button or not.

Declaration

public bool HideLayoutSwitcher { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

HtmlAttributes

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

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type
System.Object

IsMinimized

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

Declaration

public bool IsMinimized { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

LauncherIconClick

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

Declaration

public string LauncherIconClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

LauncherIconCss

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

Declaration

public string LauncherIconCss { get; set; }

Property Value

Type	Description
System.String	The default value is ""

LayoutSwitcherKeyTip

Defines the key tip text for the layoutSwitcher icon.

Declaration

public string LayoutSwitcherKeyTip { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Locale

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

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The default value is "en-us"

OverflowPopupClose

Event triggers when the overflow popup closes.

Declaration

public string OverflowPopupClose { get; set; }

Property Value

Type	Description
System.String	The default value is null

OverflowPopupOpen

Event triggers when the overflow popup opens.

Declaration

public string OverflowPopupOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

RibbonCollapsing

Event triggers before collapsing the ribbon.

Declaration

public string RibbonCollapsing { get; set; }

Property Value

Type	Description
System.String	The default value is null

RibbonExpanding

Event triggers before expanding the ribbon.

Declaration

public string RibbonExpanding { get; set; }

Property Value

Type	Description
System.String	The default value is null

RibbonLayoutSwitched

Event triggers when the ribbon layout is switched.

Declaration

public string RibbonLayoutSwitched { get; set; }

Property Value

Type	Description
System.String	The default value is null

SelectedTab

Specifies the index of the current active tab.

Declaration

public double SelectedTab { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

TabAnimation

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

Declaration

public object TabAnimation { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Tabs

Defines the list of ribbon tabs.

Declaration

public List<RibbonTab> Tabs { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<Syncfusion.EJ2.Ribbon.RibbonTab>	The default value is null

TabSelected

Event triggers after selecting the tab item.

Declaration

public string TabSelected { get; set; }

Property Value

Type	Description
System.String	The default value is null

TabSelecting

Event triggers before selecting the tab item.

Declaration

public string TabSelecting { get; set; }

Property Value

Type	Description
System.String	The default value is null

Width

Specifies the width of the ribbon.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "100%"