Class RibbonPropertiesBuilder

Class for RibbonPropertiesBuilder

Inheritance

System.Object

RibbonPropertiesBuilder

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 RibbonPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

RibbonPropertiesBuilder()

Initializes a new instance of the RibbonPropertiesBuilder class.

Declaration

public RibbonPropertiesBuilder()

RibbonPropertiesBuilder(Ribbon)

Initializes a new instance of the RibbonPropertiesBuilder class.

Declaration

public RibbonPropertiesBuilder(Ribbon Ribbon)

Parameters

Type	Name	Description
Ribbon	Ribbon	It accepts Ribbon.

Fields

Ribbon

Declaration

public Ribbon Ribbon

Field Value

Type	Description
Ribbon

Methods

AllowResizing(Boolean)

Enables the ribbon resize feature.

Declaration

[Obsolete("allowResizing is a deprecated API, we can achieve this requirement by isResponsive property")]
public RibbonPropertiesBuilder AllowResizing(bool resizable)

Parameters

Type	Name	Description
System.Boolean	resizable	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ApplicationTab(Action<ApplicationTabBuilder>)

Specifies the application tab to contain application menu or backstage page in the ribbon control.

Declaration

public RibbonPropertiesBuilder ApplicationTab(Action<ApplicationTabBuilder> applicationtab)

Parameters

Type	Name	Description
System.Action<ApplicationTabBuilder>	applicationtab	The applicationtab

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ButtonDefaults(Action<ButtonDefaultsBuilder>)

Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly and it will work only when those properties are not defined in buttonSettings and content defaults.

Declaration

public RibbonPropertiesBuilder ButtonDefaults(Action<ButtonDefaultsBuilder> buttondefaults)

Parameters

Type	Name	Description
System.Action<ButtonDefaultsBuilder>	buttondefaults	The buttondefaults

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ClientSideEvents(Action<RibbonClientSideEventsBuilder>)

It sets the list of Events to perform some ribbin functionalities.

Declaration

public RibbonPropertiesBuilder ClientSideEvents(Action<RibbonClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<RibbonClientSideEventsBuilder>	clientSideEvents	It accepts the list of events through lambda expression.

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

CollapsePinSettings(Action<CollapsePinBuilder>)

Sets custom setting to the collapsible pin in the ribbon.

Declaration

public RibbonPropertiesBuilder CollapsePinSettings(Action<CollapsePinBuilder> collapsepinsettings)

Parameters

Type	Name	Description
System.Action<CollapsePinBuilder>	collapsepinsettings	The collapsepinsettings

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

Collapsible(Boolean)

Property to enabling the ribbon rendering in collapsible mode.

Declaration

public RibbonPropertiesBuilder Collapsible(bool collapsible)

Parameters

Type	Name	Description
System.Boolean	collapsible	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ContextualTabs(Action<ContextualTabBuilder>)

Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs into the contextual tab and contextual tab set.

Declaration

public RibbonPropertiesBuilder ContextualTabs(Action<ContextualTabBuilder> contextualtabs)

Parameters

Type	Name	Description
System.Action<ContextualTabBuilder>	contextualtabs	The contextualtabs

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

CssClass(String)

Sets the root CSS class for ribbon which allow us to customize the appearance.

Declaration

public RibbonPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
RibbonPropertiesBuilder

DisabledItemIndex(List<Int32>)

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

Declaration

public RibbonPropertiesBuilder DisabledItemIndex(List<int> disabledItemIndex)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	disabledItemIndex	The disabledItemIndex

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

EnabledItemIndex(List<Int32>)

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

Declaration

public RibbonPropertiesBuilder EnabledItemIndex(List<int> enabledItemIndex)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	enabledItemIndex	The enabledItemIndex

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

EnableOnDemand(Boolean)

Property to enable the ribbon on demand rendering.

Declaration

public RibbonPropertiesBuilder EnableOnDemand(bool enableOnDemand)

Parameters

Type	Name	Description
System.Boolean	enableOnDemand	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

EnableRTL(Boolean)

Enables the ribbon rtl feature.

Declaration

public RibbonPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ExpandPinSettings(Action<ExpandPinBuilder>)

Sets custom setting to the expandable pin in the ribbon.

Declaration

public RibbonPropertiesBuilder ExpandPinSettings(Action<ExpandPinBuilder> expandpinsettings)

Parameters

Type	Name	Description
System.Action<ExpandPinBuilder>	expandpinsettings	The expandpinsettings

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

IsResponsive(Boolean)

Property to enable the ribbon responsive.

Declaration

public RibbonPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

Locale(String)

Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region and it will need to use the user’s preference.

Declaration

public RibbonPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale	The locale

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

QatItems(Action<QatItemBuilder>)

Declaration

public RibbonPropertiesBuilder QatItems(Action<QatItemBuilder> qatitems)

Parameters

Type	Name	Description
System.Action<QatItemBuilder>	qatitems

Returns

Type	Description
RibbonPropertiesBuilder

Render()

Renders this instance.

Declaration

public void Render()

RibbonTabs(Action<RibbonTabBuilder>)

Declaration

public RibbonPropertiesBuilder RibbonTabs(Action<RibbonTabBuilder> tabs)

Parameters

Type	Name	Description
System.Action<RibbonTabBuilder>	tabs

Returns

Type	Description
RibbonPropertiesBuilder

SelectedItemIndex(Int32)

Declaration

public RibbonPropertiesBuilder SelectedItemIndex(int selectedItemIndex)

Parameters

Type	Name	Description
System.Int32	selectedItemIndex

Returns

Type	Description
RibbonPropertiesBuilder

ShowBelowQAT(Boolean)

Property to enable to show the ribbon below quick access toolbar.

Declaration

public RibbonPropertiesBuilder ShowBelowQAT(bool showBelowQAT)

Parameters

Type	Name	Description
System.Boolean	showBelowQAT	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ShowQAT(Boolean)

Property to enable the ribbon quick access toolbar.

Declaration

public RibbonPropertiesBuilder ShowQAT(bool quickAccess)

Parameters

Type	Name	Description
System.Boolean	quickAccess	If set to , then ; otherwise, .

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String	An HTML-encoded string.

Width(String)

Specifies the width to the ribbon control. You can set width in string or number format.

Declaration

public RibbonPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	The width

Returns

Type	Description
RibbonPropertiesBuilder	RibbonPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString