Class Ribbon

Represents the Ribbon UI element.

Inheritance

System.Object

CommonControl

Ribbon

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class Ribbon : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Ribbon()

Declaration

public Ribbon()

Properties

AllowResizing

Gets or sets a value that indicates whether the ribbon content to be resizable.Its deprecated.Use IsResponsive instead

Declaration

[Obsolete]
public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon AllowResizing.

ApplicationTab

Declaration

public ApplicationTab ApplicationTab { get; set; }

Property Value

Type	Description
ApplicationTab

BeforeTabClick

Tiggered before the tab is Clicked.

Declaration

public string BeforeTabClick { get; set; }

Property Value

Type	Description
System.String

BeforeTabRemove

Tiggered before the tab is removed.

Declaration

public string BeforeTabRemove { get; set; }

Property Value

Type	Description
System.String

ButtonDefaults

Gets or sets the ribbon ButtonDefaults settings.

Declaration

public ButtonDefaults ButtonDefaults { get; set; }

Property Value

Type	Description
ButtonDefaults	The ribbon ButtonDefaults.

Collapse

Triggered after the ribbon is collapsed.

Declaration

public string Collapse { get; set; }

Property Value

Type	Description
System.String

CollapsePinSettings

Gets or sets the ribbon CollapsePinSettings.

Declaration

public CollapsePinSettings CollapsePinSettings { get; set; }

Property Value

Type	Description
CollapsePinSettings	The ribbon CollapsePinSettings.

Collapsible

Gets or sets a value that indicates whether the ribbon render with Collapse.

Declaration

public bool Collapsible { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon Collapsible.

ContextualTabs

Specifies the contextual tabs and tab set to the ribbon control with the background color and border color.

Declaration

public List<ContextualTab> ContextualTabs { get; }

Property Value

Type	Description
System.Collections.Generic.List<ContextualTab>	The ContextualTabs.

Create

Triggered when the ribbon is rendered completely.

Declaration

public string Create { get; set; }

Property Value

Type	Description
System.String

CssClass

Specifies the cssClass of the Ribbon to customize the Ribbon UI

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The ribbon CssClass

Destroy

Triggered when ribbon going to destroy.

Declaration

public string Destroy { get; set; }

Property Value

Type	Description
System.String

DisabledItemIndex

Specifies the index or indexes to disable the given index tab or indexes tabs in the ribbon control.

Declaration

public List<int> DisabledItemIndex { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The DisabledItemIndex.

EnabledItemIndex

Specifies the index or indexes to enable the given index tab or indexes tabs in the ribbon control.

Declaration

public List<int> EnabledItemIndex { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The EnabledItemIndex.

EnableOnDemand

Gets or sets a value that indicates whether the ribbon render with OnDemand.

Declaration

public bool EnableOnDemand { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon EnableOnDemand.

EnableRTL

Gets or sets the align content in the ribbon from right to left by setting the property as true.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon EnableRTL.

Expand

Triggered after the ribbon is expanded.

Declaration

public string Expand { get; set; }

Property Value

Type	Description
System.String

ExpandPinSettings

Gets or sets the ribbon ExpandPinSettings.

Declaration

public ExpandPinSettings ExpandPinSettings { get; set; }

Property Value

Type	Description
ExpandPinSettings	The ribbon ExpandPinSettings.

GalleryItemClick

Triggered after the gallery item is clicked.

Declaration

public string GalleryItemClick { get; set; }

Property Value

Type	Description
System.String

GroupClick

Triggered after the group is clicked.

Declaration

public string GroupClick { get; set; }

Property Value

Type	Description
System.String

GroupExpand

Triggered after the group expanded is clicked.

Declaration

public string GroupExpand { get; set; }

Property Value

Type	Description
System.String

IsResponsive

Gets or sets a value that indicates whether the ribbon design has be to made responsive.

Declaration

public bool IsResponsive { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon IsResponsive.

Load

Triggered before the ribbon is render starts.

Declaration

public string Load { get; set; }

Property Value

Type	Description
System.String

Locale

Gets or sets the ribbon Locale.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The ribbon Locale.

Model

Gets or sets the ribbon model.

Declaration

[JsonIgnore]
public RibbonProperties Model { get; set; }

Property Value

Type	Description
RibbonProperties	The ribbon model.

QatItems

Specifies the QatItmes and its groups.

Declaration

public List<QatItems> QatItems { get; }

Property Value

Type	Description
System.Collections.Generic.List<QatItems>	The QatItmes.

QatMenuItemClick

Triggered after the quick access menu item is clicked.

Declaration

public string QatMenuItemClick { get; set; }

Property Value

Type	Description
System.String

RibbonTabs

Specifies the tabs and its groups.

Declaration

public List<RibbonTab> RibbonTabs { get; }

Property Value

Type	Description
System.Collections.Generic.List<RibbonTab>	The RibbonTabs.

SelectedItemIndex

Specifies the index of the ribbon tab to select the given index tab item in the ribbon control.

Declaration

public int SelectedItemIndex { get; set; }

Property Value

Type	Description
System.Int32	The SelectedItemIndex.

ShowBelowQAT

Gets or sets a value that indicates whether to show quick access toolbar below the ribbon.

Declaration

public bool ShowBelowQAT { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon ShowBelowQAT.

ShowQAT

Gets or sets a value that indicates whether to enable quick mode button options in ribbon.

Declaration

public bool ShowQAT { get; set; }

Property Value

Type	Description
System.Boolean	The ribbon ShowQAT.

TabAdd

Triggered after the tab is added to ribbon.

Declaration

public string TabAdd { get; set; }

Property Value

Type	Description
System.String

TabClick

Triggered after the tab is clicked.

Declaration

public string TabClick { get; set; }

Property Value

Type	Description
System.String

TabCreate

Triggered before the tab created.

Declaration

public string TabCreate { get; set; }

Property Value

Type	Description
System.String

TabRemove

Triggered after the tab is removed from ribbon.

Declaration

public string TabRemove { get; set; }

Property Value

Type	Description
System.String

TabSelect

Triggered after the tab is selected.

Declaration

public string TabSelect { get; set; }

Property Value

Type	Description
System.String

ToggleButtonClick

Triggered after the expand/collapse button is clicked.

Declaration

public string ToggleButtonClick { get; set; }

Property Value

Type	Description
System.String

Width

Gets or sets the ribbon Width.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The ribbon Width.

Methods

DependentScripts()

To get the dependant scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	The collection of scripts.

GetDependentFiles()

To get the Dependent files.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>	The collection of files.

Overrides

CommonControl.GetDependentFiles()

LoadViewState(Object)

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonControl.LoadViewState(Object)

OnPreRender(EventArgs)

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Gets a value that specifies to render the ribbon.

Declaration

public string Render()

Returns

Type	Description
System.String	It returns the String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Restores view-state information from a previous page request that was saved by the System.Web.UI.WebControls.DataBoundControl.SaveViewState method.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

ServerGalleryItemClick

Declaration

public event Ribbon.RibbonGalleryClickEventHandler ServerGalleryItemClick

Event Type

Type	Description
Ribbon.RibbonGalleryClickEventHandler

ServerGroupClick

Declaration

public event Ribbon.RibbonGroupClickEventHandler ServerGroupClick

Event Type

Type	Description
Ribbon.RibbonGroupClickEventHandler

ServerTabSelect

Declaration

public event Ribbon.RibbonEventHandler ServerTabSelect

Event Type

Type	Description
Ribbon.RibbonEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService