Class RibbonTab

A class that represents tab of RibbonTabs component.

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

Constructors

RibbonTab()

Declaration
public RibbonTab()

Properties

CssClass

Gets or sets one or more CSS classes to customize the RibbonTab.

Declaration
[Parameter]
public string CssClass { get; set; }
Property Value
Type Description
string

Accepts a CSS class string separated by spaces to customize the appearance of the RibbonTab. The default value is String.Empty.
Remarks

This property allows you to specify one or more CSS classes that will be applied to the RibbonTab.

HeaderText

Gets or sets the header text of the RibbonTab.

Declaration
[Parameter]
public string HeaderText { get; set; }
Property Value
Type Description
string

Accepts a string that represents the header text of the RibbonTab. The default value is String.Empty.
Remarks

This property allows you to specify the text that will be displayed as the header for the RibbonTab.

ID

Gets or sets the unique ID for the RibbonTab.

Declaration
[Parameter]
public string ID { get; set; }
Property Value
Type Description
string

The ID of the RibbonTab. The default value is String.Empty.
Remarks

This property allows you to assign a unique identifier to the RibbonTab.

KeyTip

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

Declaration
[Parameter]
public string KeyTip { get; set; }
Property Value
Type Description
string

A string representing the key tip text for the tab. Defaults to an empty string.
Remarks

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

Visible

Gets or sets a value indicating whether the tab is visible in the SfRibbon component.

Declaration
[Parameter]
public bool Visible { get; set; }
Property Value
Type Description
bool

A boolean value that specifies the visibility of the tab. The default value is true, meaning the tab is visible by default.
Remarks

Use this property to control the visibility of the tab dynamically based on the application's state or user actions. When set to false, the tab will be hidden in the SfRibbon component.

VisibleChanged

Event raised when the Visible property value has changed.

Declaration
[Parameter]
public EventCallback<bool> VisibleChanged { get; set; }
Property Value
Type
EventCallback<bool>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

Dispose unmanaged resources in the Syncfusion Blazor component.

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

Boolean value to dispose the object.
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements