Class RibbonGalleryItem

Represents an individual item of a RibbonGallery that is used in a SfRibbon control.

Inheritance

System.Object

RibbonGalleryItem

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Ribbon

Assembly: Syncfusion.Ribbon.WinUI.dll

Syntax

public class RibbonGalleryItem : ButtonBase, IDisposable

Constructors

RibbonGalleryItem()

Initializes a new instance of the RibbonGalleryItem class.

Declaration

public RibbonGalleryItem()

Fields

GroupNameProperty

Identifies the GroupName dependency property.

Declaration

public static readonly DependencyProperty GroupNameProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

IsSelectedProperty

Identifies the IsSelected dependency property.

Declaration

public static readonly DependencyProperty IsSelectedProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

SelectsOnInvokedProperty

Identifies the SelectsOnInvoked dependency property.

Declaration

public static readonly DependencyProperty SelectsOnInvokedProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Properties

GroupName

Gets or sets a value of group name which is used to group the RibbonGalleryItem and gets displayed while expanding the control.

Declaration

public string GroupName { get; set; }

Property Value

Type	Description
System.String	The name that specifies which ribbon gallery items are mutually exclusive. The default value is an empty string.

IsSelected

Gets or sets a value indicating whether item is selected or not.

Declaration

public bool IsSelected { get; }

Property Value

Type	Description
System.Boolean	true if the RibbonGalleryItem is selected; otherwise, false.The default value is false.

SelectsOnInvoked

Gets or sets a value indicating whether the item can be invoked or not.

Declaration

public bool SelectsOnInvoked { get; set; }

Property Value

Type	Description
System.Boolean	true if invoking a ribbon gallery item also selects it; otherwise, false.The default value is false.

Methods

Dispose()

Release the unmanaged resources of RibbonGalleryItem.

Declaration

public void Dispose()

Dispose(Boolean)

Release the unmanaged resources of RibbonGalleryItem.

Declaration

protected virtual void Dispose(bool isDisposing)

Parameters

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

OnCreateAutomationPeer()

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

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

OnPointerEntered(PointerRoutedEventArgs)

Occurs when a pointer enters the hit test area of the RibbonGalleryItem.

Declaration

protected override void OnPointerEntered(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs that contains the event data.

OnPointerExited(PointerRoutedEventArgs)

Occurs when a pointer leaves the hit test area of the RibbonGalleryItem.

Declaration

protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs that contains the event data.

OnPointerPressed(PointerRoutedEventArgs)

Occurs when the pointer device initiates a Press action within the RibbonGalleryItem.

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs that contains the event data.

OnTapped(TappedRoutedEventArgs)

Declaration

protected override void OnTapped(TappedRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.TappedRoutedEventArgs	e

Implements

System.IDisposable