Class RibbonGroupButtonSettings

Provides settings for a group button within a Ribbon control.

Inheritance

System.Object

RibbonGroupButtonSettings

Namespace: Syncfusion.Blazor.Ribbon

Assembly: Syncfusion.Blazor.dll

Syntax

public class RibbonGroupButtonSettings : OwningComponentBase

Constructors

RibbonGroupButtonSettings()

Declaration

public RibbonGroupButtonSettings()

Properties

HeaderText

Gets or sets the header text for the group button popup in Simplified layout of the RibbonTab.

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	Accepts a string that represents the header text for the group button popup in Simplified layout. The default value is String.Empty.

Remarks

This property allows you to specify the text that will be displayed as the header for the group button popup in Simplified layout.

HtmlAttributes

Gets or sets additional HTML attributes to be applied to the button.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type
System.Collections.Generic.Dictionary<System.String, System.Object>

ItemClick

Gets or sets an event callback that is raised before clicking the button from the group button.

Declaration

public EventCallback<GroupButtonClickEventArgs> ItemClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<GroupButtonClickEventArgs>	An event callback function that takes a GroupButtonClickEventArgs parameter.

Remarks

This event allows you to execute custom logic or prevent the click action before it occurs. The GroupButtonClickEventArgs provides information about the clicked button and the event.

Items

Gets or sets the collection of button items in the Ribbon group button.

Declaration

public List<GroupButtonItem> Items { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GroupButtonItem>	A collection of GroupButtonItem objects that define the properties for each button item in the Ribbon group. The default value is null.

Remarks

Use this property to configure the collection of button items within the Ribbon group. Each item can be customized using the GroupButtonItem model. If the value is null, no button items are defined for the Ribbon group.

Selection

Gets or sets the selection mode of the group button in the ribbon.

Declaration

public GroupButtonSelection Selection { get; set; }

Property Value

Type	Description
GroupButtonSelection	A GroupButtonSelection value that specifies the button selection mode. The default value is Single. The possible values are: Single - Allows only a single button to be selected at a time. Multiple - Allows multiple buttons to be selected simultaneously.

Remarks

This property determines how buttons within a ribbon group can be selected.

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