Class RibbonGroup

Inheritance

System.Object

SfBaseComponent

RibbonGroup

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.OnAfterRenderAsync(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.Ribbon

Assembly: Syncfusion.Blazor.dll

Syntax

public class RibbonGroup : SfBaseComponent

Constructors

RibbonGroup()

Declaration

public RibbonGroup()

Properties

ChildContent

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

CssClass

Gets or sets the CSS classes to customize the appearance of the RibbonGroup.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	Accepts a string of CSS classes separated by spaces to customize the appearance of the RibbonGroup. The default value is `String.Empty`.

Remarks

This property allows you to apply one or more CSS classes to the RibbonGroup to change its appearance according to your design requirements.

EnableGroupOverflow

Gets or sets a value indicating whether to add a separate popup for the overflow items in the RibbonGroup.
If it is set to false, the overflow items will be shown in the common overflow popup present at the right end of the tab content.

Declaration

public bool EnableGroupOverflow { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that indicates whether to add a separate popup for the overflow items in the RibbonGroup. The default value is `false`. ///

Remarks

This property controls the display of overflow items within a RibbonGroup. When set to true, a separate popup will be created specifically for overflow items in that group. /// When set to false, overflow items will be included in a common overflow popup that is typically located at the right end of the ribbon tab content.

GroupIconCss

Gets or sets the CSS class for the icons to be shown in the RibbonGroup overflow dropdown button in classic mode.

Declaration

public string GroupIconCss { get; set; }

Property Value

Type	Description
System.String	A string that represents the CSS class for the icons in the group overflow dropdown button. The default value is System.String.Empty.

Remarks

During overflow, the entire group will be shown in a popup of a dropdown button which appears in the place of the RibbonGroup in the RibbonTab. This property allows you to customize the appearance of the icons in the overflow dropdown button.

HeaderText

Gets or sets the header text of the RibbonGroup.

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	A string that represents the header text of the RibbonGroup. The default value is `String.Empty`.

Remarks

This property specifies the text that appears as the header of the RibbonGroup. The header text is typically displayed at the top of the ribbon group and provides a label or title for the group, helping users understand the contents or purpose of the group.

ID

Gets or sets the unique ID for the RibbonGroup.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	The ID of the RibbonGroup. The default value is `String.Empty`.

Remarks

This property specifies a unique identifier for the RibbonGroup. The ID can be used to reference the ribbon group dynamically. Setting a unique ID is useful for scenarios where you need to uniquely identify the ribbon group within the DOM, especially when dealing with multiple ribbon groups.

IsCollapsed

Gets or sets a value indicating whether the RibbonGroup is in a collapsed state during classic mode.

Declaration

public bool IsCollapsed { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that indicates whether the RibbonGroup is in a collapsed state. The default value is `false`.

Remarks

This property determines whether the RibbonGroup is displayed in a collapsed state when the ribbon is in classic mode. When set to true, the ribbon group will be collapsed, showing only its header and hiding the content until expanded.

IsCollapsible

Gets or sets a value indicating whether the RibbonGroup can be collapsed on resize during classic mode.

Declaration

public bool IsCollapsible { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that indicates whether the RibbonGroup can be collapsed on resize. The default value is `true`.

Remarks

This property determines whether the RibbonGroup can automatically collapse when the ribbon is resized in classic mode. When set to true, the ribbon group will collapse to save space when the ribbon's width is reduced.

KeyTip

Gets or sets the key tip text for the group in the SfRibbon component.

Declaration

public string KeyTip { get; set; }

Property Value

Type	Description
System.String	A string representing the key tip text for the group. Defaults to an empty string.

Remarks

The KeyTip property allows to specify a keyboard shortcut for a particular group in the SfRibbon component. When key tips are enabled, users can press the associated key combination to quickly access the corresponding group.

LauncherIconKeyTip

Gets or sets the key tip content for the launcher icon in the SfRibbon component.

Declaration

public string LauncherIconKeyTip { get; set; }

Property Value

Type	Description
System.String	A string representing the key tip text for the launcher icon. Defaults to an empty string.

Remarks

The LauncherIconKeyTip property allows to define a key tip for the launcher icon within the SfRibbon component. This provides a keyboard shortcut to quickly activate the launcher icon.

Orientation

Gets or sets the orientation of the items in the RibbonGroup.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation	An Orientation value that represents the orientation of the items. The default value is Column.

Remarks

This property determines how the items within the RibbonGroup are arranged. The orientation can be either horizontal or vertical, depending on the value of the Orientation enumeration. Column: Items are arranged vertically in a single column. Row: Items are arranged horizontally in a single row.

PopupHeaderText

Gets or sets the header shown in the overflow popup for the RibbonGroup.

Declaration

public string PopupHeaderText { get; set; }

Property Value

Type	Description
System.String	A string that represents the header shown in the overflow popup for the RibbonGroup. The default value is `String.Empty`.

Remarks

This property defines the text that appears as the header in the overflow popup of the RibbonGroup. The overflow popup is used to display additional items that do not fit within the visible area of the ribbon. The header text helps users identify and understand the contents of the overflow popup.

Priority

Gets or sets the priority order at which the RibbonGroup should be collapsed or expanded. For expanding, the value is fetched in ascending order, and for collapsing, the value is fetched in descending order.

Declaration

public int Priority { get; set; }

Property Value

Type	Description
System.Int32	An integer that represents the priority order for collapsing or expanding the RibbonGroup. The default value is `0`.

Remarks

This property determines the order in which the RibbonGroup is collapsed or expanded based on its priority.

ShowLauncherIcon

Gets or sets a value indicating whether to show or hide the launcher icon for the RibbonGroup.

Declaration

public bool ShowLauncherIcon { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that indicates whether the launcher icon for the RibbonGroup is shown or hidden. The default value is `false`.

Remarks

The launcher icon is a small button usually displayed in the lower-right corner of the RibbonGroup.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Overrides

SfBaseComponent.Dispose(Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnInitializedAsync()