Class RibbonGroupButtonSettings

Provides settings for a group button within a Ribbon control.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
RibbonGroupButtonSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Ribbon
Assembly: Syncfusion.Blazor.dll
Syntax
public class RibbonGroupButtonSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

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
[Parameter]
public string HeaderText { get; set; }
Property Value
Type Description
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.

ItemClick

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

Declaration
[Parameter]
public EventCallback<GroupButtonClickEventArgs> ItemClick { get; set; }
Property Value
Type Description
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
[Parameter]
public List<GroupButtonItem> Items { get; set; }
Property Value
Type Description
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
[Parameter]
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(bool)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

Implements