WinUI

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RibbonGroup - WinUI API Reference | Syncfusion RibbonTab. ">

    Show / Hide Table of Contents

    Class RibbonGroup

    Represents a logical group of controls as they appear on a RibbonTab.

    Inheritance
    System.Object
    RibbonGroup
    Implements
    System.IDisposable
    Namespace: Syncfusion.UI.Xaml.Ribbon
    Assembly: Syncfusion.Ribbon.WinUI.dll
    Syntax
    public class RibbonGroup : ItemsControl, IDisposable

    Constructors

    RibbonGroup()

    Initializes a new instance of the RibbonGroup class.

    Declaration
    public RibbonGroup()

    Fields

    HeaderProperty

    Identifies the Header dependency property.

    Declaration
    public static readonly DependencyProperty HeaderProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    LauncherButtonCommandProperty

    Identifies the LauncherButtonCommand dependency property.

    Declaration
    public static readonly DependencyProperty LauncherButtonCommandProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    OverflowItemDisplayModeProperty

    Identifies the OverflowItemDisplayMode dependency property.

    Declaration
    public static readonly DependencyProperty OverflowItemDisplayModeProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    PriorityProperty

    Identifies the Priority property.

    Declaration
    public static readonly DependencyProperty PriorityProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    ShowLauncherButtonProperty

    Identifies the ShowLauncherButton dependency property.

    Declaration
    public static readonly DependencyProperty ShowLauncherButtonProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    Properties

    Header

    Gets or sets the content for the RibbonGroup's header.

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

    The content for the RibbonGroup's header. The default value is null.

    LauncherButtonCommand

    Gets or sets the command to invoke when launcher button is clicked.

    Declaration
    public ICommand LauncherButtonCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    The command to execute when the launcher button is clicked. The default value is null.

    OverflowItemDisplayMode

    Gets or sets a value of OverFlowItemDisplayMode where it represent whether to show the overflow IRibbonItem within RibbonGroup or at the end of RibbonTab content area.

    Declaration
    public OverFlowItemDisplayMode OverflowItemDisplayMode { get; set; }
    Property Value
    Type Description
    OverFlowItemDisplayMode

    The default value is TabLevel. Fields:

    EnumerationDescription
    TabLevelMoves the overflow ribbon items to tab level overflow button.
    GroupLevelMoves the overflow ribbon items to group level ovevrflow button.

    Priority

    Gets or sets the resize priority value, RibbonGroup is fetched within the tab to resize based on this value. For collapsing value is fetched in descending order and for expanding value is fetched in ascending order.

    Declaration
    public int Priority { get; set; }
    Property Value
    Type Description
    System.Int32

    The priority number to resize. The default value is zero.

    Examples

    This code example shows how to declare and use SfRibbon control.

    <ribbon:RibbonTab Header="Tab #1">
       <ribbon:RibbonGroup Priority="3"
                           AllowCollapse="True">
           <ribbon:RibbonButton Content="Button"
                                AllowedSizeModes="Large, Normal, Small"/>
           <ribbon:RibbonButton Content="Button"
                                AllowedSizeModes="Large, Small"/>
           <ribbon:RibbonButton Content="Button"
                                AllowedSizeModes="Large, Normal"/>
       </ribbon:RibbonGroup>
       <ribbon:RibbonGroup Priority="2"
                           AllowCollapse="False">
           <ribbon:RibbonButton Content="Button"
                                AllowedSizeModes="Normal, Small"/>
           <ribbon:RibbonItemHost>
               <ribbon:RibbonItemHost.ItemTemplate>
                   <DataTemplate>
                       <CheckBox />
                   </DataTemplate>
               </ribbon:RibbonItemHost.ItemTemplate>
           </ribbon:RibbonItemHost>
           <ribbon:RibbonSplitButton Content="Button"
                                     AllowedSizeModes="Small"/>
       </ribbon:RibbonGroup>
       <ribbon:RibbonGroup Priority="1">
           <ribbon:RibbonButton Content="Button"/>
           <ribbon:RibbonDropDownButton Content="Button"	
                                        AllowedSizeModes="Normal"/>
       </ribbon:RibbonGroup>
    </ribbon:RibbonTab>

    ShowLauncherButton

    Gets or sets a value that indicates whether the launcher button is displayed in a RibbonGroup.

    Declaration
    public bool ShowLauncherButton { get; set; }
    Property Value
    Type Description
    System.Boolean

    true, if the launcher button is shown; otherwise false. The default value is true

    See Also
    LauncherButtonCommand

    Methods

    Dispose()

    Release the unmanaged resources of RibbonGroup.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Release the unmanaged resources of RibbonGroup.

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

    true if unmanaged resources should be disposed; otherwise, false.

    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()

    Contains the template logic of RibbonGroup.

    Declaration
    protected override void OnApplyTemplate()

    OnCreateAutomationPeer()

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type Description
    Microsoft.UI.Xaml.Automation.Peers.AutomationPeer

    Events

    LauncherButtonClick

    Occurs when the launcher button is clicked in RibbonGroup.

    Declaration
    public event TypedEventHandler<RibbonGroup, object> LauncherButtonClick
    Event Type
    Type Description
    Windows.Foundation.TypedEventHandler<RibbonGroup, System.Object>
    Examples

    This example demonstrates how to invoke LauncherButtonClick event.

    RibbonGroup ribbonGroup = new RibbonGroup();
    ribbonGroup.LauncherButtonClick += RibbonGroup_LauncherButtonClick;
    private void RibbonGroup_LauncherButtonClick(RibbonGroup sender, object args)
    {
    

    }

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved