Class
RadRibbonSplitButton

A Button control for usage in the RadRibbonView.

Definition

Namespace:Telerik.UI.Xaml.Controls

Assembly:Telerik.WinUI.Controls.dll

Syntax:

cs-api-definition
public class RadRibbonSplitButton : ButtonBase, IRibbonButton, IVariantControl

Inheritance: objectRadRibbonSplitButton

Implements: IRibbonButtonIVariantControl

Constructors

RadRibbonSplitButton()

Initializes a new instance of the RadRibbonSplitButton class.

Declaration

cs-api-definition
public RadRibbonSplitButton()

Fields

CheckedEvent

Occurs when the Button part become checked.

Declaration

cs-api-definition
public static readonly RoutedEvent CheckedEvent

Field Value

RoutedEvent

ClickEvent

Identifies the Click property.

Declaration

cs-api-definition
public static readonly RoutedEvent ClickEvent

Field Value

RoutedEvent

CollapseToMediumProperty

Identifies the CollapseToMedium property.

Declaration

cs-api-definition
public static readonly DependencyProperty CollapseToMediumProperty

Field Value

DependencyProperty

CollapseToSmallProperty

Identifies the CollapseToSmall property.

Declaration

cs-api-definition
public static readonly DependencyProperty CollapseToSmallProperty

Field Value

DependencyProperty

CurrentSizeProperty

Identifies the CurrentSize property.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentSizeProperty

Field Value

DependencyProperty

DropDownIndicatorVisibilityProperty

Identifies the DropDownIndicatorVisibility property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownIndicatorVisibilityProperty

Field Value

DependencyProperty

FlyoutProperty

Identifies the Flyout property.

Declaration

cs-api-definition
public static readonly DependencyProperty FlyoutProperty

Field Value

DependencyProperty

IsAutoSizeProperty

Identifies the IsAutoSize property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsAutoSizeProperty

Field Value

DependencyProperty

IsBackgroundVisibleProperty

Identifies the IsBackgroundVisible property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsBackgroundVisibleProperty

Field Value

DependencyProperty

IsCheckedProperty

Identifies the IsChecked property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsCheckedProperty

Field Value

DependencyProperty

IsTextInMiddleButtonProperty

Identifies the IsTextInMiddleButton property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsTextInMiddleButtonProperty

Field Value

DependencyProperty

IsToggleProperty

Identifies the IsToggle property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsToggleProperty

Field Value

DependencyProperty

LargeIconProperty

Identifies the LargeIcon property.

Declaration

cs-api-definition
public static readonly DependencyProperty LargeIconProperty

Field Value

DependencyProperty

SizeProperty

Identifies the Size property.

Declaration

cs-api-definition
public static readonly DependencyProperty SizeProperty

Field Value

DependencyProperty

SmallIconProperty

Identifies the SmallIcon property.

Declaration

cs-api-definition
public static readonly DependencyProperty SmallIconProperty

Field Value

DependencyProperty

SplitTextProperty

Identifies the SplitText property.

Declaration

cs-api-definition
public static readonly DependencyProperty SplitTextProperty

Field Value

DependencyProperty

TextProperty

Identifies the Text property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextProperty

Field Value

DependencyProperty

TextRow1Property

Identifies the TextRow1 property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextRow1Property

Field Value

DependencyProperty

TextRow2Property

Identifies the TextRow2 property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextRow2Property

Field Value

DependencyProperty

UncheckedEvent

Occurs when the Button part become unchecked.

Declaration

cs-api-definition
public static readonly RoutedEvent UncheckedEvent

Field Value

RoutedEvent

Properties

CollapseToMedium

Get/Set the guidance about button's resize to the Medium size. This is a dependency property.

Declaration

cs-api-definition
public CollapseThreshold CollapseToMedium { get; set; }

Property Value

CollapseThreshold

Implements IRibbonButton.CollapseToMedium

CollapseToSmall

Get/Set the guidance about button's resize to the Small size. This is a dependency property.

Declaration

cs-api-definition
public CollapseThreshold CollapseToSmall { get; set; }

Property Value

CollapseThreshold

Implements IRibbonButton.CollapseToSmall

CurrentSize

Get/Set the current State-size of the button. This is a dependency property.

Declaration

cs-api-definition
public ButtonSize CurrentSize { get; }

Property Value

ButtonSize

Implements IRibbonButton.CurrentSize

DropDownIndicatorVisibility

Gets or sets a value indicating the visibility of the drop down indicator.

Declaration

cs-api-definition
public Visibility DropDownIndicatorVisibility { get; set; }

Property Value

Visibility

Flyout

Gets or sets the Flyout of this button.

Declaration

cs-api-definition
public FlyoutBase Flyout { get; set; }

Property Value

FlyoutBase

IsAutoSize

Get/Set the permission to resize the Image according to the RibbonView guidance. This is a dependency property.

Declaration

cs-api-definition
public bool IsAutoSize { get; set; }

Property Value

bool

IsBackgroundVisible

Sets the visual appearance of the chrome not to render in Normal mode.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsBackgroundVisible { get; set; }

Property Value

bool

IsChecked

Simulates the IsChecked of the ToggleButton.

Declaration

cs-api-definition
public bool IsChecked { get; set; }

Property Value

bool

IsTextInMiddleButton

Get/Set the placement of the text in the Middle-sized button. This is a dependency property.

Declaration

cs-api-definition
public bool IsTextInMiddleButton { get; set; }

Property Value

bool

IsToggle

Gets or sets whether the button supports toggle mode.

Declaration

cs-api-definition
public bool IsToggle { get; set; }

Property Value

bool

LargeIcon

Get/Set the LargeIcon that is shown in Large button state. This is a dependency property.

Declaration

cs-api-definition
public IconElement LargeIcon { get; set; }

Property Value

IconElement

Implements IRibbonButton.LargeIcon

Size

Get/Set the button initial size. In fact this is the max-size that the button can implement. This is a dependency property.

Declaration

cs-api-definition
public ButtonSize Size { get; set; }

Property Value

ButtonSize

Implements IRibbonButton.Size

SmallIcon

Get/Set the SmallIcon that is shown in Medium and Small button state. This is a dependency property.

Declaration

cs-api-definition
public IconElement SmallIcon { get; set; }

Property Value

IconElement

Implements IRibbonButton.SmallIcon

SplitText

Enable/disable the Text splitting for the Large-sized button. This is a dependency property.

Declaration

cs-api-definition
public bool SplitText { get; set; }

Property Value

bool

Text

Get/Set the Text label that is shown in Medium and Large button state. This is a dependency property.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

Implements IRibbonButton.Text

TextRow1

Get/Set the Text label that is shown in Medium and Large button state. This is a dependency property.

Declaration

cs-api-definition
public string TextRow1 { get; }

Property Value

string

TextRow2

Get/Set the Text label that is shown only in Large button state. This is a dependency property.

Declaration

cs-api-definition
public string TextRow2 { get; }

Property Value

string

Methods

Close()

Hides the flyout of the button.

Declaration

cs-api-definition
public void Close()

OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call. .

Declaration

cs-api-definition
protected override void OnApplyTemplate()

OnChecked()

Called when IsChecked property is initialised to true. Raises the Checked events.

Declaration

cs-api-definition
protected virtual void OnChecked()

OnClick(bool)

Toggle the IsOpen property and execute the associated Command.

Declaration

cs-api-definition
protected void OnClick(bool executeCommand = false)

Parameters

executeCommand

bool

OnCreateAutomationPeer()

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnGotFocus(RoutedEventArgs)

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

OnKeyDown(KeyRoutedEventArgs)

Declaration

cs-api-definition
protected override void OnKeyDown(KeyRoutedEventArgs e)

Parameters

e

KeyRoutedEventArgs

OnKeyUp(KeyRoutedEventArgs)

Declaration

cs-api-definition
protected override void OnKeyUp(KeyRoutedEventArgs e)

Parameters

e

KeyRoutedEventArgs

OnLostFocus(RoutedEventArgs)

Declaration

cs-api-definition
protected override void OnLostFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

OnToggle()

Toggle the IsChecked property and raise the Checked/Unchecked events.

Declaration

cs-api-definition
protected virtual void OnToggle()

OnUnchecked()

Called when IsChecked property is initialised to false. Raises the Unchecked events.

Declaration

cs-api-definition
protected virtual void OnUnchecked()

Open()

Opens the flyout of the button.

Declaration

cs-api-definition
public void Open()

SetVariant(RibbonGroupVariant)

Implements the interface for button resizing in order to follow the resize mechanism of the ribbon group.

Declaration

cs-api-definition
public void SetVariant(RibbonGroupVariant variant)

Parameters

variant

RibbonGroupVariant

Implements IVariantControl.SetVariant(RibbonGroupVariant)

Events

Checked

Occurs when the action button is checked.

Declaration

cs-api-definition
public event RoutedEventHandler Checked

Event Value

RoutedEventHandler

Unchecked

Occurs when the action button is unchecked.

Declaration

cs-api-definition
public event RoutedEventHandler Unchecked

Event Value

RoutedEventHandler