Class SfRibbonToggleButton

Represents class for RibbonToggleButton

Inheritance
System.Object
SfRibbonToggleButton
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.Controls.SfRibbon
Assembly: Syncfusion.SfRibbon.UWP.dll
Syntax
public class SfRibbonToggleButton : ToggleButton, IDisposable

Constructors

SfRibbonToggleButton()

Initializes a new instance of the SfRibbonToggleButton class.

Declaration
public SfRibbonToggleButton()

Fields

FontIconFontFamilyProperty

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

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

FontIconProperty

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

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

FontIconSizeProperty

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

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

HeaderProperty

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

Declaration
public static readonly DependencyProperty HeaderProperty
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

LabelProperty

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

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

SizeModeProperty

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

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

ToolTipProperty

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

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

Properties

FontIcon

Gets or sets the FontIcon.

Declaration
[ClassReference(IsReviewed = false)]
public string FontIcon { get; set; }
Property Value
Type Description
System.String

The default value is empty string.

FontIconFontFamily

Gets or sets the FontIcon's FontFamily.

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

The default value is null.

FontIconSize

Gets or sets the FontIconSize.

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

Header

Gets or sets the Header.

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

The default value is null.

Icon

Gets or sets the Icon.

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

The default value is null.

Label

Gets or sets the Label.

Declaration
[ClassReference(IsReviewed = false)]
public string Label { get; set; }
Property Value
Type Description
System.String

The default value is null.

SizeMode

Gets or sets the SizeMode.

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

The default value is SizeMode.Small.

ToolTip

Gets or sets the ToolTip.

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

The default value is null.

Methods

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

boolean disposing

OnApplyTemplate()

Initializes all the child elements

Declaration
protected override void OnApplyTemplate()

OnPointerEntered(PointerRoutedEventArgs)

Called when a pointer enters the area of this element.

Declaration
protected override void OnPointerEntered(PointerRoutedEventArgs e)
Parameters
Type Name Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs e

pointer routed event parameter

OnPointerExited(PointerRoutedEventArgs)

Called when a pointer leaves the area of this element.

Declaration
protected override void OnPointerExited(PointerRoutedEventArgs e)
Parameters
Type Name Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs e

pointer routed event parameter

OnPointerMoved(PointerRoutedEventArgs)

Called when a pointer moves over the area of this element.

Declaration
protected override void OnPointerMoved(PointerRoutedEventArgs e)
Parameters
Type Name Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs e

pointer routed event parameter

OnToggle()

Called when this instance is Toggled

Declaration
protected override void OnToggle()

Implements

System.IDisposable

Extension Methods