ASP.NET MVC

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RibbonProperties - ASP.NETMVC API Reference | Syncfusion

    Show / Hide Table of Contents

    Class RibbonProperties

    Inheritance
    System.Object
    EJTagHelper
    RibbonProperties
    Inherited Members
    EJTagHelper.GetControlDetails(String)
    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.Models
    Assembly: Syncfusion.EJ.dll
    Syntax
    public class RibbonProperties : EJTagHelper

    Constructors

    RibbonProperties()

    Declaration
    public RibbonProperties()

    Properties

    AllowResizing

    Gets or sets a value indicating whether ribbon control to enable/disable the Resize property

    Declaration
    [JsonProperty("allowResizing")]
    [Obsolete("allowResizing is a deprecated API, we can achieve this requirement by isResponsive property")]
    public bool AllowResizing { get; set; }
    Property Value
    Type Description
    System.Boolean

    if ; otherwise, .

    ApplicationTab

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

    Declaration
    [JsonProperty("applicationTab")]
    public ApplicationTab ApplicationTab { get; set; }
    Property Value
    Type Description
    ApplicationTab

    The applicationTab

    BackstageItemClick

    Gets or sets triggered when a tab or button in the backstage page is clicked successfully.

    Declaration
    [JsonProperty("backstageItemClick")]
    public string BackstageItemClick { get; set; }
    Property Value
    Type Description
    System.String

    The backstageItemClick

    BeforeTabClick

    Gets or sets to triggered before the ribbon tab item is Clicked.

    Declaration
    [JsonProperty("beforeTabClick")]
    public string BeforeTabClick { get; set; }
    Property Value
    Type Description
    System.String

    The beforeTabRemove

    BeforeTabRemove

    Gets or sets to triggered before the ribbon tab item is removed.

    Declaration
    [JsonProperty("beforeTabRemove")]
    public string BeforeTabRemove { get; set; }
    Property Value
    Type Description
    System.String

    The beforeTabRemove

    ButtonDefaults

    Gets or sets 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
    [JsonProperty("buttonDefaults")]
    public ButtonDefaults ButtonDefaults { get; set; }
    Property Value
    Type Description
    ButtonDefaults

    The buttonDefaults

    ClientSideOnBackStageItemClick

    Depreacated. Use BackstaeItemClick instead

    Declaration
    [Obsolete]
    public string ClientSideOnBackStageItemClick { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeTabRemove

    Depreacated. Use BeforeTabRemove instead

    Declaration
    [Obsolete]
    public string ClientSideOnBeforeTabRemove { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnCreate

    Depreacated. Use Create instead

    Declaration
    [Obsolete]
    public string ClientSideOnCreate { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnDestroy

    Depreacated. Use Destroy instead

    Declaration
    [Obsolete]
    public string ClientSideOnDestroy { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnGalleryItemClick

    Depreacated. Use GalleryItemClick instead

    Declaration
    [Obsolete]
    public string ClientSideOnGalleryItemClick { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnGroupClick

    Depreacated. Use GroupClick instead

    Declaration
    [Obsolete]
    public string ClientSideOnGroupClick { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnGroupExpand

    Depreacated. Use GroupExpand instead

    Declaration
    [Obsolete]
    public string ClientSideOnGroupExpand { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnTabAdd

    Depreacated. Use TabAdd instead

    Declaration
    [Obsolete]
    public string ClientSideOnTabAdd { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnTabClick

    Depreacated. Use TabClick instead

    Declaration
    [Obsolete]
    public string ClientSideOnTabClick { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnTabCreate

    Depreacated. Use TabCreate instead

    Declaration
    [Obsolete]
    public string ClientSideOnTabCreate { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnTabRemove

    Depreacated. Use TabRemove instead

    Declaration
    [Obsolete]
    public string ClientSideOnTabRemove { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnTabSelect

    Depreacated. Use TabSelect instead

    Declaration
    [Obsolete]
    public string ClientSideOnTabSelect { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnToggleButtonClick

    Depreacated. Use ToggleButtonClick instead

    Declaration
    [Obsolete]
    public string ClientSideOnToggleButtonClick { get; set; }
    Property Value
    Type Description
    System.String

    Collapse

    Gets or sets triggered when the ribbon control is collapsed.

    Declaration
    [JsonProperty("collapse")]
    public string Collapse { get; set; }
    Property Value
    Type Description
    System.String

    The collapse

    CollapsePinSettings

    Gets or sets custom setting to the collapsible pin in the ribbon.

    Declaration
    [JsonProperty("collapsePinSettings")]
    public CollapsePinSettings CollapsePinSettings { get; set; }
    Property Value
    Type Description
    CollapsePinSettings

    The collapsePinSettings

    Collapsible

    Gets or sets a value indicating whether this instance control to enable/disable the Collapsible property

    Declaration
    [JsonProperty("collapsible")]
    public bool Collapsible { get; set; }
    Property Value
    Type Description
    System.Boolean

    if this instance ; otherwise, .

    ContextualTabs

    Gets or sets 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
    [JsonProperty("contextualTabs")]
    public List<ContextualTab> ContextualTabs { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ContextualTab>

    The contextualTabs

    Create

    Triggered when the ribbon is rendered completely.

    Declaration
    [JsonProperty("create")]
    public string Create { get; set; }
    Property Value
    Type Description
    System.String

    The create

    CssClass

    Sets the custom class for the ribbon control

    Declaration
    [JsonProperty("cssClass")]
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    CssClass

    Destroy

    Gets or sets triggered before the ribbon control is destroyed.

    Declaration
    [JsonProperty("destroy")]
    public string Destroy { get; set; }
    Property Value
    Type Description
    System.String

    The destroy

    DisabledItemIndex

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

    Declaration
    [JsonProperty("disabledItemIndex")]
    public List<int> DisabledItemIndex { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    The disabledItemIndex

    EnabledItemIndex

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

    Declaration
    [JsonProperty("enabledItemIndex")]
    public List<int> EnabledItemIndex { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    The enabledItemIndex

    EnableOnDemand

    Gets or sets a value indicating whether ribbon control to enable/disable the enableOnDemand property

    Declaration
    [JsonProperty("enableOnDemand")]
    public bool EnableOnDemand { get; set; }
    Property Value
    Type Description
    System.Boolean

    if ; otherwise, .

    EnableRTL

    Gets or sets a value indicating whether to enable the ribbon enableRTL.

    Declaration
    [JsonProperty("enableRTL")]
    public bool EnableRTL { get; set; }
    Property Value
    Type Description
    System.Boolean

    if ; otherwise, .

    Expand

    Gets or sets triggered when the ribbon control is expanded.

    Declaration
    [JsonProperty("expand")]
    public string Expand { get; set; }
    Property Value
    Type Description
    System.String

    The expand

    ExpandPinSettings

    Gets or sets custom setting to the expandable pin in the ribbon.

    Declaration
    [JsonProperty("expandPinSettings")]
    public ExpandPinSettings ExpandPinSettings { get; set; }
    Property Value
    Type Description
    ExpandPinSettings

    The expandPinSettings

    GalleryItemClick

    Gets or sets triggered when an item in the Gallery control is clicked successfully.

    Declaration
    [JsonProperty("galleryItemClick")]
    public string GalleryItemClick { get; set; }
    Property Value
    Type Description
    System.String

    The galleryItemClick

    GroupClick

    Gets or sets triggered when the control in the group is clicked successfully.

    Declaration
    [JsonProperty("groupClick")]
    public string GroupClick { get; set; }
    Property Value
    Type Description
    System.String

    The groupClick

    GroupExpand

    Gets or sets triggered when the group expander in the group is clicked successfully.

    Declaration
    [JsonProperty("groupExpand")]
    public string GroupExpand { get; set; }
    Property Value
    Type Description
    System.String

    The groupExpand

    IsResponsive

    Gets or sets a value indicating whether this instance control to enable/disable the Responsive property

    Declaration
    [JsonProperty("isResponsive")]
    public bool IsResponsive { get; set; }
    Property Value
    Type Description
    System.Boolean

    if this instance ; otherwise, .

    Load

    Triggered before the ribbon is render starts.

    Declaration
    [JsonProperty("load")]
    public string Load { get; set; }
    Property Value
    Type Description
    System.String

    The load

    Locale

    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
    [JsonProperty("locale")]
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    The locale

    QatItems

    Gets or sets a value indicating whether to enable the ribbon quick access toolbar items.

    Declaration
    [JsonProperty("qatItems")]
    public List<QatItems> QatItems { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<QatItems>

    The qatItems

    QatMenuItemClick

    Gets or sets triggered when the QAT menu item is clicked successfully .

    Declaration
    [JsonProperty("qatMenuItemClick")]
    public string QatMenuItemClick { get; set; }
    Property Value
    Type Description
    System.String

    The qatMenuItemClick

    RibbonTabs

    Gets or sets the tabs to present in the contextual tabs and tab set. Refer to the tabs section for adding tabs into the contextual tabs and tab set.

    Declaration
    [JsonProperty("tabs")]
    public List<RibbonTab> RibbonTabs { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<RibbonTab>

    The tabs

    SelectedItemIndex

    Gets or sets the index of the ribbon tab to select the given index tab item in the ribbon control.

    Declaration
    [JsonProperty("selectedItemIndex")]
    public int SelectedItemIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    The selectedItemIndex

    ShowBelowQAT

    Gets or sets a value indicating whether to enable the ribbon below quick access toolbar.

    Declaration
    [JsonProperty("showBelowQAT")]
    public bool ShowBelowQAT { get; set; }
    Property Value
    Type Description
    System.Boolean

    if ; otherwise, .

    ShowQAT

    Gets or sets a value indicating whether to enable the ribbon quick access toolbar.

    Declaration
    [JsonProperty("showQAT")]
    public bool ShowQAT { get; set; }
    Property Value
    Type Description
    System.Boolean

    if ; otherwise, .

    TabAdd

    Gets or sets triggered after adding the new ribbon tab item.

    Declaration
    [JsonProperty("tabAdd")]
    public string TabAdd { get; set; }
    Property Value
    Type Description
    System.String

    The tabAdd

    TabClick

    Gets or sets triggered when tab is clicked successfully in the ribbon control.

    Declaration
    [JsonProperty("tabClick")]
    public string TabClick { get; set; }
    Property Value
    Type Description
    System.String

    The tabClick

    TabCreate

    Gets or sets triggered before the ribbon tab is created.

    Declaration
    [JsonProperty("tabCreate")]
    public string TabCreate { get; set; }
    Property Value
    Type Description
    System.String

    The tabCreate

    TabRemove

    Gets or sets triggered after the tab item is removed from the ribbon control.

    Declaration
    [JsonProperty("tabRemove")]
    public string TabRemove { get; set; }
    Property Value
    Type Description
    System.String

    The tabRemove

    TabSelect

    Gets or sets triggered after the ribbon tab item is selected in the ribbon control.

    Declaration
    [JsonProperty("tabSelect")]
    public string TabSelect { get; set; }
    Property Value
    Type Description
    System.String

    The tabSelect

    ToggleButtonClick

    Gets or sets triggered when the expand/collapse button is clicked successfully .

    Declaration
    [JsonProperty("toggleButtonClick")]
    public string ToggleButtonClick { get; set; }
    Property Value
    Type Description
    System.String

    The toggleButtonClick

    Width

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

    Declaration
    [JsonProperty("width")]
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    The width

    Methods

    GetControlDetails()

    Declaration
    protected override object GetControlDetails()
    Returns
    Type Description
    System.Object
    Overrides
    EJTagHelper.GetControlDetails()

    ShouldSerializeApplicationTab()

    ShouldSerialize Methods for ApplicationTab

    Declaration
    public bool ShouldSerializeApplicationTab()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeButtonDefaults()

    ShouldSerialize Methods for ButtonDefaults

    Declaration
    public bool ShouldSerializeButtonDefaults()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeCollapsePinSettings()

    ShouldSerialize Methods for CollapsePinSettings

    Declaration
    public bool ShouldSerializeCollapsePinSettings()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeExpandPinSettings()

    ShouldSerialize Methods for ExpandPinSettings

    Declaration
    public bool ShouldSerializeExpandPinSettings()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeTabs()

    ShouldSerialize Methods for Tabs

    Declaration
    public bool ShouldSerializeTabs()
    Returns
    Type Description
    System.Boolean
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved