menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfRibbon - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfRibbon

    Represents class for Ribbon

    Inheritance
    System.Object
    SfRibbon
    SfSpreadsheetRibbon
    Implements
    System.IDisposable
    Namespace: Syncfusion.UI.Xaml.Controls.SfRibbon
    Assembly: Syncfusion.SfRibbon.UWP.dll
    Syntax
    [ClassReference(IsReviewed = false)]
    public class SfRibbon : ItemsControl, IDisposable

    Constructors

    SfRibbon()

    Initializes a new instance of the SfRibbon class.

    Declaration
    public SfRibbon()

    Fields

    AccentBrushProperty

    Using a DependencyProperty as the backing store for AccentBrush. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty AccentBrushProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    BackStageHeaderProperty

    Using a DependencyProperty as the backing store for BackStageHeader. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty BackStageHeaderProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    BackStageProperty

    Using a DependencyProperty as the backing store for BackStage. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty BackStageProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    BackStageWidthProperty

    Using a DependencyProperty as the backing store for BackStageWidth. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty BackStageWidthProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    ContentProperty

    Using a DependencyProperty as the backing store for Content. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty ContentProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    IconProperty

    Using a DependencyProperty as the backing store for Icon. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty IconProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    IsQATBelowProperty

    Using a DependencyProperty as the backing store for IsQATBelow. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty IsQATBelowProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    QATVisibilityProperty

    Using a DependencyProperty as the backing store for QATVisibility. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty QATVisibilityProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    QuickAccessToolBarProperty

    Using a DependencyProperty as the backing store for QuickAccessToolBar. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty QuickAccessToolBarProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    RibbonStateProperty

    Using a DependencyProperty as the backing store for RibbonState. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty RibbonStateProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    RibbonTabPopupWidthProperty

    Using a DependencyProperty as the backing store for RibbonTabPopupWidth. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty RibbonTabPopupWidthProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    SelectedIndexProperty

    Using a DependencyProperty as the backing store for SelectedIndex. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty SelectedIndexProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    SelectedItemProperty

    Using a DependencyProperty as the backing store for SelectedItem. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty SelectedItemProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    TabPanelItemProperty

    Using a DependencyProperty as the backing store for TabPanelItem. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty TabPanelItemProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    TabPanelVisibilityProperty

    Using a DependencyProperty as the backing store for TabPanelVisibility. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty TabPanelVisibilityProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    TitleAlignmentProperty

    Using a DependencyProperty as the backing store for TitleAlignment. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty TitleAlignmentProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    TitleProperty

    Using a DependencyProperty as the backing store for Title. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty TitleProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    ToggleButtonVisibilityProperty

    Using a DependencyProperty as the backing store for ToggleButtonVisibility. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty ToggleButtonVisibilityProperty
    Field Value
    Type
    Windows.UI.Xaml.DependencyProperty

    Properties

    AccentBrush

    Gets or sets the AccentBrush

    Declaration
    [ClassReference(IsReviewed = false)]
    public Brush AccentBrush { get; set; }
    Property Value
    Type
    Windows.UI.Xaml.Media.Brush

    BackStage

    Gets or sets the BackStage

    Declaration
    [ClassReference(IsReviewed = false)]
    public SfBackstage BackStage { get; set; }
    Property Value
    Type
    SfBackstage

    BackStageHeader

    Gets or sets the BackStageHeader

    Declaration
    [ClassReference(IsReviewed = false)]
    public object BackStageHeader { get; set; }
    Property Value
    Type
    System.Object

    BackStageWidth

    Gets or sets the BackStageWidth

    Declaration
    [ClassReference(IsReviewed = false)]
    public double BackStageWidth { get; set; }
    Property Value
    Type
    System.Double

    Content

    Gets or sets the content property

    Declaration
    public object Content { get; set; }
    Property Value
    Type
    System.Object

    Icon

    Gets or sets the Icon

    Declaration
    [ClassReference(IsReviewed = false)]
    public ImageSource Icon { get; set; }
    Property Value
    Type
    Windows.UI.Xaml.Media.ImageSource

    IsQATBelow

    Gets or sets a value indicating whether the IsQATBelow

    Declaration
    [ClassReference(IsReviewed = false)]
    public bool IsQATBelow { get; set; }
    Property Value
    Type
    System.Boolean

    QATVisibility

    Gets or sets the QATVisibility

    Declaration
    [ClassReference(IsReviewed = false)]
    public Visibility QATVisibility { get; set; }
    Property Value
    Type
    Windows.UI.Xaml.Visibility

    QuickAccessToolBar

    Gets or sets the QuickAccessToolBar

    Declaration
    [ClassReference(IsReviewed = false)]
    public QuickAccessToolBar QuickAccessToolBar { get; set; }
    Property Value
    Type
    QuickAccessToolBar

    RibbonState

    Gets or sets the RibbonState

    Declaration
    [ClassReference(IsReviewed = false)]
    public RibbonState RibbonState { get; set; }
    Property Value
    Type
    RibbonState

    RibbonTabPopupWidth

    Gets or sets the RibbonTabComboBoxPopupWidth

    Declaration
    [ClassReference(IsReviewed = false)]
    public double RibbonTabPopupWidth { get; set; }
    Property Value
    Type
    System.Double

    SelectedIndex

    Gets or sets the SelectedIndex

    Declaration
    [ClassReference(IsReviewed = false)]
    public int SelectedIndex { get; set; }
    Property Value
    Type
    System.Int32

    SelectedItem

    Gets or sets the SelectedItem

    Declaration
    [ClassReference(IsReviewed = false)]
    public SfRibbonTab SelectedItem { get; set; }
    Property Value
    Type
    SfRibbonTab

    TabPanelItem

    Gets or sets the TabPanelItem

    Declaration
    [ClassReference(IsReviewed = false)]
    public object TabPanelItem { get; set; }
    Property Value
    Type
    System.Object

    TabPanelVisibility

    Gets or sets the TabPanelVisibility

    Declaration
    [ClassReference(IsReviewed = false)]
    public Visibility TabPanelVisibility { get; set; }
    Property Value
    Type
    Windows.UI.Xaml.Visibility

    Title

    Gets or sets the Title

    Declaration
    [ClassReference(IsReviewed = false)]
    public object Title { get; set; }
    Property Value
    Type
    System.Object

    TitleAlignment

    Gets or sets the TitleAlignment

    Declaration
    [ClassReference(IsReviewed = false)]
    public HorizontalAlignment TitleAlignment { get; set; }
    Property Value
    Type
    Windows.UI.Xaml.HorizontalAlignment

    ToggleButtonVisibility

    Gets or sets the ToggleButtonVisibility

    Declaration
    [ClassReference(IsReviewed = false)]
    public Visibility ToggleButtonVisibility { get; set; }
    Property Value
    Type
    Windows.UI.Xaml.Visibility

    Methods

    CloseBackStage()

    Method to CloseBackStage

    Declaration
    [ClassReference(IsReviewed = false)]
    public void CloseBackStage()

    DeSerialize()

    Load the RibbonState, Ribbon SelectedIndex and QAT customization.

    Declaration
    [ClassReference(IsReviewed = false)]
    public void DeSerialize()

    Dispose()

    dispose method

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Method for dispose

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    disposing parameter

    GetContainerForItemOverride()

    Creates or identifies the element that is used to display the given item

    Declaration
    protected override DependencyObject GetContainerForItemOverride()
    Returns
    Type Description
    Windows.UI.Xaml.DependencyObject

    returns Dependency Object

    HideRibbonTabPanel()

    Method for hiding ribbon tab panel

    Declaration
    public void HideRibbonTabPanel()

    IsItemItsOwnContainerOverride(Object)

    Determines if the specified item is (or is eligible to be) its own container

    Declaration
    protected override bool IsItemItsOwnContainerOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    object item

    Returns
    Type Description
    System.Boolean

    returns boolean

    OnApplyTemplate()

    Initializes all the child elements of the Ribbon

    Declaration
    protected override void OnApplyTemplate()

    OpenBackStage()

    Method to OpenBackStage

    Declaration
    [ClassReference(IsReviewed = false)]
    public void OpenBackStage()

    PrepareContainerForItemOverride(DependencyObject, Object)

    Arranges the container for over ride items

    Declaration
    protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
    Parameters
    Type Name Description
    Windows.UI.Xaml.DependencyObject element

    Dependency Object

    System.Object item

    object item

    Serialize()

    Save the RibbonState, Ribbon SelectedIndex and QAT customization.

    Declaration
    [ClassReference(IsReviewed = false)]
    public void Serialize()

    ShowRibbonTabPanel()

    Method for showing ribbon tab panel

    Declaration
    public void ShowRibbonTabPanel()

    Events

    BackStageClosed

    BackStageClosed event will be raised when backstage is closed.

    Declaration
    [ClassReference(IsReviewed = false)]
    public event EventHandler BackStageClosed
    Event Type
    Type
    System.EventHandler

    BackStageOpened

    BackStageOpened event will be raised when backstage is opened.

    Declaration
    [ClassReference(IsReviewed = false)]
    public event EventHandler BackStageOpened
    Event Type
    Type
    System.EventHandler

    RibbonTabPanelClosed

    Occurs when Ribbon tab panel is closed.

    Declaration
    [ClassReference(IsReviewed = false)]
    public event EventHandler RibbonTabPanelClosed
    Event Type
    Type
    System.EventHandler

    RibbonTabPanelOpened

    Occurs when Ribbon tab panel is opened.

    Declaration
    [ClassReference(IsReviewed = false)]
    public event EventHandler RibbonTabPanelOpened
    Event Type
    Type
    System.EventHandler

    Implements

    System.IDisposable

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved