Class BackstageMenuItem
Inheritance
Inherited Members
Namespace: Syncfusion.Blazor.Ribbon
Assembly: Syncfusion.Blazor.dll
Syntax
public class BackstageMenuItem : SfBaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposableConstructors
BackstageMenuItem()
Declaration
public BackstageMenuItem()Properties
ID
Gets or sets the unique identifier for the backstage menu item.
Declaration
[Parameter]
public string ID { get; set; }Property Value
| Type | Description |
|---|---|
| string | A string that represents the unique identifier for the backstage menu item. The default value is an empty string. |
Remarks
This identifier can be used to uniquely reference the menu item within the application, such as for dynamic manipulation of menu items. Ensure that each backstage menu item has a unique ID to avoid conflicts.
IconCss
Gets or sets the CSS class for the icon displayed on the Backstage Menu item.
Declaration
[Parameter]
public string IconCss { get; set; }Property Value
| Type | Description |
|---|---|
| string | A string representing the CSS class to be applied to the menu item's icon. The default value is an empty string. |
Remarks
Use this property to specify a custom icon for the menu item by setting the CSS class that corresponds to the desired icon. This allows integration with icon libraries like Font Awesome, Material Icons, or custom icon sets.
IsFooter
Gets or sets a value indicating whether the item is a footer item.
Declaration
[Parameter]
public bool IsFooter { get; set; }Property Value
| Type | Description |
|---|---|
| bool | A boolean value indicating whether the Backstage Menu item is a footer item. The default value is |
Remarks
Set this property to true to position the item in the footer of the Backstage Menu.
KeyTip
Gets or sets the key tip text for a backstage menu item 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 backstage menu item. Defaults to an empty string. |
Remarks
This property allows you to specify a keyboard shortcut (key tip) for a specific backstage menu item within the SfRibbon component. When key tips are enabled, users can press the assigned key combination to quickly activate the corresponding menu item.
Separator
Gets or sets a value indicating whether the item is a separator.
Declaration
[Parameter]
public bool Separator { get; set; }Property Value
| Type | Description |
|---|---|
| bool | A boolean value indicating whether the Backstage Menu item is a separator. The default value is |
Remarks
Set this property to true to create a visual separator between menu items. This is useful for grouping related menu items.
Text
Gets or sets the text for the Backstage Menu item.
Declaration
[Parameter]
public string Text { get; set; }Property Value
| Type | Description |
|---|---|
| string | A string that specifies the text content to be displayed for the Backstage Menu item. The default value is an empty string. |
Remarks
Use this property to set a descriptive label or name for the Backstage Menu item. This text will be visible to users and should provide meaningful context about the item.
Methods
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. |