Class SpreadsheetRibbonGroup

Represents the state and metadata of a ribbon group in the SfSpreadsheet's ribbon interface.

Inheritance

object

SpreadsheetRibbonGroup

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Spreadsheet

Assembly: Syncfusion.Blazor.Spreadsheet.dll

Syntax

public class SpreadsheetRibbonGroup

Remarks

This model is used to customize built-in ribbon groups by controlling their visibility, display order, and parent tab. SpreadsheetRibbonGroup instances are passed to the RibbonGroupItems parameter.

• Built-in groups are identified by their GroupId (e.g., "clipboardGroup", "fontStyleGroup").
• Set IsVisible to false to hide a group from its parent tab.
• Set Order to control group ordering within a tab; null preserves existing order.

Examples

Example: Customizing ribbon groups

@using Syncfusion.Blazor.Spreadsheet
@using Syncfusion.Blazor.Ribbon

<SfSpreadsheet @ref="SpreadsheetInstance"
               RibbonGroupItems="@GetGroupCustomizations()">
</SfSpreadsheet>

@code {
    public SfSpreadsheet SpreadsheetInstance { get; set; }

    List<SpreadsheetRibbonGroup> GetGroupCustomizations()
    {
        return new List<SpreadsheetRibbonGroup>
        {
            new SpreadsheetRibbonGroup { GroupId = "bordersGroup", TabId = "homeTab", IsVisible = false },
            new SpreadsheetRibbonGroup { GroupId = "fontStyleGroup", TabId = "homeTab", Order = 1 }
        };
    }
}

Constructors

SpreadsheetRibbonGroup()

Declaration

public SpreadsheetRibbonGroup()

Properties

GroupId

Gets or sets the unique identifier for the ribbon group.

Declaration

public string GroupId { get; set; }

Property Value

Type	Description
string	A string representing the group's unique identifier. The default value is Empty.

Remarks

For built-in groups, standard IDs include:

• "clipboardGroup" - Cut, Copy, Paste operations.
• "fontStyleGroup" - Bold, Italic, Underline, Strikethrough formatting.
• "bordersGroup" - Border drawing and border color controls.

For custom groups, use a developer-provided unique identifier.

IsBuiltIn

Gets a value indicating whether this is a built-in group or a custom group.

Declaration

public bool IsBuiltIn { get; }

Property Value

Type	Description
bool	true if this is a built-in spreadsheet group; false if this is a custom group. This property is read-only and automatically managed.

Remarks

This property is automatically set by the framework and cannot be modified by users. Built-in groups correspond to standard ribbon groups such as Clipboard, Font Style, Borders, and Alignment.

IsVisible

Gets or sets a value indicating whether the group is visible in its parent tab.

Declaration

public bool IsVisible { get; set; }

Property Value

Type	Description
bool	A bool indicating group visibility. The default value is true.

Order

Gets or sets the display order of the group within its parent tab.

Declaration

public int? Order { get; set; }

Property Value

Type	Description
int?	An int? (nullable integer) representing the desired group order. The default value is null.

Remarks

Groups with lower Order values appear first within the tab from left to right.

• When null, the group's existing order is preserved (the user did not customize the order).
• When set to a specific integer, the group is repositioned accordingly within the tab.
• Multiple groups can share the same order value; final order depends on insertion order in such cases.

TabId

Gets or sets the unique identifier of the parent tab containing this group.

Declaration

public string TabId { get; set; }

Property Value

Type	Description
string	A string representing the parent tab's ID. The default value is Empty.

Remarks

This property specifies which tab owns this group. For built-in groups, the parent tab is typically "homeTab".