Class RibbonGallerySettings

Inheritance

System.Object

RibbonGallerySettings

Namespace: Syncfusion.Blazor.Ribbon

Assembly: Syncfusion.Blazor.dll

Syntax

public class RibbonGallerySettings : OwningComponentBase

Constructors

RibbonGallerySettings()

Declaration

public RibbonGallerySettings()

Properties

Groups

Gets or sets the properties for the collection of gallery items in the Ribbon.

Declaration

public List<GalleryGroup> Groups { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GalleryGroup>	A list of GalleryGroup that represents the gallery groups. The default value is null.

Remarks

Use this property to configure multiple gallery groups, each containing a collection of items displayed in the Ribbon.

ItemCount

Gets or sets the number of items to be displayed in the Ribbon Gallery.

Declaration

public int ItemCount { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the number of items in the gallery. The default value is 3.

Remarks

This property controls how many items are visible in the Ribbon Gallery at a time. Increasing this number will display more items.

ItemHover

Gets or sets an event callback that is raised when a user hovers over a gallery item.

Declaration

public EventCallback<GalleryItemHoverEventArgs> ItemHover { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GalleryItemHoverEventArgs>	An event callback function of type GalleryItemHoverEventArgs.

Remarks

Use this event to customize hover effects or display additional information.

ItemRendering

Gets or sets an event callback that is raised before rendering each gallery item.

Declaration

public EventCallback<GalleryItemRenderEventArgs> ItemRendering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GalleryItemRenderEventArgs>	An event callback function of type GalleryItemRenderEventArgs.

Remarks

This event provides a way to customize the rendering of individual gallery items.

PopupClosing

Gets or sets an event callback that is raised when the gallery popup closes.

Declaration

public EventCallback<GalleryPopupCloseEventArgs> PopupClosing { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GalleryPopupCloseEventArgs>	An event callback function of type GalleryPopupCloseEventArgs.

Remarks

Use this event to handle logic before the gallery popup closes.

PopupHeight

Gets or sets the height of the Ribbon gallery popup.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	A string specifying the height of the popup. The default value is "auto".

Remarks

The height can be specified in pixel values or other CSS-supported units. The default setting adjusts the height automatically based on the content.

PopupOpening

Gets or sets an event callback that is raised when the gallery popup opens.

Declaration

public EventCallback<GalleryPopupOpenEventArgs> PopupOpening { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GalleryPopupOpenEventArgs>	An event callback function of type GalleryPopupOpenEventArgs.

Remarks

This event is triggered when the Ribbon Gallery popup opens.

PopupTemplate

Sets the template for the gallery items in the popup.

Declaration

public RenderFragment<GalleryItemContext> PopupTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<GalleryItemContext>	A context of GalleryItemContext that specifies the template for the gallery items in the popup. The default value is null.

Remarks

Use this property to customize the content of items displayed in the Ribbon Gallery popup.

PopupWidth

Gets or sets the width of the Ribbon gallery popup.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String	A string specifying the width of the popup. The default value is "auto".

Remarks

The width can be specified in pixel values or other CSS-supported units. The default setting adjusts the width automatically based on the content.

Selected

Gets or sets an event callback that is raised when the gallery item is selected.

Declaration

public EventCallback<GallerySelectedEventArgs> Selected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GallerySelectedEventArgs>	An event callback function of type GallerySelectedEventArgs.

Remarks

Use this event to handle actions when an item is selected.

SelectedItemIndex

Gets or sets the index of the currently selected gallery item. Supports two-way binding.

Declaration

public int SelectedItemIndex { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the index of the selected item. The default value is 0.

Remarks

This property specifies which item is currently selected in the gallery. Indexing starts at 0, so the first item is at index 0. Define @bind-SelectedItemIndex to use two-way binding.

SelectedItemIndexChanged

Declaration

public EventCallback<int> SelectedItemIndexChanged { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Int32>

Selecting

Gets or sets an event callback that is raised when selecting a gallery item.

Declaration

public EventCallback<GallerySelectEventArgs> Selecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GallerySelectEventArgs>	An event callback function of type GallerySelectEventArgs.

Remarks

This event is triggered before a gallery item is selected, allowing you to cancel the action if needed.

Template

Sets the template for the gallery item contents.

Declaration

public RenderFragment<GalleryItemContext> Template { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<GalleryItemContext>	A context of GalleryItemContext that specifies the template for the gallery items. The default value is null.

Remarks

This property allows you to define a custom template for the content of each gallery item.

Methods

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task