Class RibbonSplitButton

Represents a composite control with a primary button that responds to a click event and a secondary button that displays a drop-down list of mutually exclusive values.

Inheritance

System.Object

RibbonSplitButton

Implements

IRibbonElement

IRibbonItem

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Ribbon

Assembly: Syncfusion.Ribbon.WinUI.dll

Syntax

public class RibbonSplitButton : Button, IRibbonElement, IRibbonItem, IDisposable

Remarks

The RibbonSplitButton control displays in different ActiveSizeMode variations such as large, medium, and small, and with no images.

Examples

<ribbon:RibbonSplitButton Content="Paste"
                          SizeMode="Small">
   <ribbon:RibbonSplitButton.Icon>
       <SymbolIcon Symbol="Paste" />
   </ribbon:RibbonSplitButton.Icon>
   <ribbon:RibbonSplitButton.Flyout>
        <MenuFlyout>
            <MenuFlyoutItem Text="Paste Special" />
            <MenuFlyoutItem Text="Set Default Paste" />
        </MenuFlyout>
   </ribbon:RibbonSplitButton.Flyout>
</ribbon:RibbonSplitButton>

Constructors

RibbonSplitButton()

Initializes a new instance of the RibbonSplitButton control.

Declaration

public RibbonSplitButton()

Fields

AllowedSizeModesProperty

Identifies the AllowedSizeModes property.

Declaration

public static readonly DependencyProperty AllowedSizeModesProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

DisplayOptionsProperty

Identifies the DisplayOptions property.

Declaration

public static readonly DependencyProperty DisplayOptionsProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

IconProperty

Identifies the Icon dependency property.

Declaration

public static readonly DependencyProperty IconProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

ScreenTipProperty

Identifies the ScreenTip property.

Declaration

public static readonly DependencyProperty ScreenTipProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Properties

AllowedSizeModes

Gets or sets the size mode options for ribbon element. Using any of these options, the ribbon element gets arranged when resizing the ribbon.

Declaration

public RibbonElementSizeModes AllowedSizeModes { get; set; }

Property Value

Type	Description
RibbonElementSizeModes	The default value is Large | Normal | Small. Fields: Enumeration Description Small Displays only the Image. Normal Displays image along with the content in Horizontal arrangement. Large Displays image along with the content in Vertical arrangement.

DisplayOptions

Gets or sets the way that the ribbon items are displayed in different LayoutModeOptions.

Declaration

public DisplayOptions DisplayOptions { get; set; }

Property Value

Type	Description
DisplayOptions	The default value is Normal | Simplified. Fields: Enumeration Description Normal The IRibbonItem gets displayed when SfRibbon is in Normal. Simplified The IRibbonItem gets displayed when SfRibbon is in Simplified. Overflow The IRibbonItem gets displayed in overflow menu when SfRibbon is in Simplified.

Icon

Gets or sets an icon that appears in a RibbonSplitButton.

Declaration

public IconElement Icon { get; set; }

Property Value

Type
Microsoft.UI.Xaml.Controls.IconElement

Examples

<ribbon:RibbonSplitButton Content="Paste"
                          SizeMode="Small">
   <ribbon:RibbonSplitButton.Icon>
       <SymbolIcon Symbol="Paste" />
   </ribbon:RibbonSplitButton.Icon>
   <ribbon:RibbonSplitButton.Flyout>
        <MenuFlyout>
            <MenuFlyoutItem Text="Paste Special" />
            <MenuFlyoutItem Text="Set Default Paste" />
        </MenuFlyout>
   </ribbon:RibbonSplitButton.Flyout>
</ribbon:RibbonSplitButton>

<ribbon:RibbonSplitButton Content="Paste"
                          SizeMode="Normal">
   <ribbon:RibbonSplitButton.Icon>
       <FontIcon FontFamily="Segoe MDL2 Assets"
                 FontSize="16"
                 Glyph="&#xED25;" />
   </ribbon:RibbonSplitButton.Icon>
   <ribbon:RibbonSplitButton.Flyout>
        <MenuFlyout>
            <MenuFlyoutItem Text="Paste Special" />
            <MenuFlyoutItem Text="Set Default Paste" />
        </MenuFlyout>
   </ribbon:RibbonSplitButton.Flyout>
</ribbon:RibbonSplitButton>

<ribbon:RibbonSplitButton Content="Paste"
                          SizeMode="Large">
   <ribbon:RibbonSplitButton.Icon>
       <BitmapIcon UriSource="ms-appx:///Assets/Paste.png" />
   </ribbon:RibbonSplitButton.Icon>
   <ribbon:RibbonSplitButton.Flyout>
        <MenuFlyout>
            <MenuFlyoutItem Text="Paste Special" />
            <MenuFlyoutItem Text="Set Default Paste" />
        </MenuFlyout>
   </ribbon:RibbonSplitButton.Flyout>
</ribbon:RibbonSplitButton>

ScreenTip

Gets or sets the ScreenTip that is used to show a pop-up window when the pointer hovers over a ribbon item to provide details about its functionality.

Declaration

public ScreenTip ScreenTip { get; set; }

Property Value

Type	Description
ScreenTip	The default is null.

Examples

<ribbon:RibbonSplitButton Content="Paste"
                          Icon="Paste"
                          AllowedSizeModes="Large">
    <ribbon:RibbonSplitButton.Flyout>
        <MenuFlyout>
            <MenuFlyoutItem Text = "Paste" />
            < MenuFlyoutItem Text="Paste Special" />
            <MenuFlyoutItem Text = "Set Default Paste" />
        </ MenuFlyout >
    </ ribbon:RibbonSplitButton.Flyout>
</ribbon:RibbonSplitButton>
    <ribbon:RibbonSplitButton.ScreenTip>
          <ribbon:ScreenTip Title ="Paste" Content="Paste the contents of clipboard."  />
    </ribbon:RibbonSplitButton.ScreenTip>                          
</ribbon:RibbonSplitButton>

Methods

Dispose()

Release the unmanaged resources of RibbonSplitButton.

Declaration

public void Dispose()

Dispose(Boolean)

Release the unmanaged resources of RibbonSplitButton.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if unmanaged resources should be disposed; otherwise, false.

OnApplyTemplate()

Contains the template logic of RibbonSplitButton.

Declaration

protected override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type
Microsoft.UI.Xaml.Automation.Peers.AutomationPeer

Explicit Interface Implementations

IRibbonElement.ActiveSizeMode

Gets or sets the current SizeMode value of ribbon item which represent the how the image and content of ribbon items get arranged.

Declaration

SizeMode IRibbonElement.ActiveSizeMode { get; set; }

Returns

Type	Description
SizeMode	Small mode arrange the ribbon item only with image, Normal mode arrange the ribbon item with image and content in horizontal layout, where in Large mode arrange the ribbon with image and content in vertical layout. The default value is Normal.

IRibbonItem.Clone()

This method helps to clone the ribbon split button.

Declaration

FrameworkElement IRibbonItem.Clone()

Returns

Type
Microsoft.UI.Xaml.FrameworkElement

Implements

IRibbonElement

IRibbonItem

System.IDisposable