Class RibbonBackstageMenuSettings

Inheritance

System.Object

SfBaseComponent

RibbonBackstageMenuSettings

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.GetEffectivePlatform()

SfBaseComponent.GetMainComponentPlatform()

SfBaseComponent.IsMainLicenseComponent()

SfBaseComponent.LicenseContext

SfBaseComponent.OnAfterRenderAsync(Boolean)

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

SfBaseComponent.ValidateLicense()

Namespace: Syncfusion.Blazor.Ribbon

Assembly: Syncfusion.Blazor.dll

Syntax

public class RibbonBackstageMenuSettings : SfBaseComponent

Constructors

RibbonBackstageMenuSettings()

Declaration

public RibbonBackstageMenuSettings()

Properties

BackButtonSettings

Gets or sets the settings for the Back button in the Backstage Menu.

Declaration

public BackstageBackButtonSettings BackButtonSettings { get; set; }

Property Value

Type	Description
BackstageBackButtonSettings	An instance of the BackstageBackButtonSettings class that specifies the settings for the Back button.

Remarks

The BackstageBackButtonSettings class provides configuration options for the Back button, such as its appearance, behavior, and other related settings.

BackstageItemClick

Event raised when a backstage menu item is clicked in the SfRibbon component.

Declaration

public EventCallback<BackstageItemClickEventArgs> BackstageItemClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BackstageItemClickEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> where T is BackstageItemClickEventArgs.

Remarks

This event is triggered when a user clicks on a menu item within the backstage view of the SfRibbon component. It provides an opportunity to handle user interactions with backstage menu items. The BackstageItemClickEventArgs contains information about the clicked item.

ChildContent

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

Height

Gets or sets the height of the Backstage Menu in the SfRibbon component.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	A string that specifies the height of the Backstage Menu. The default value is "auto".

Remarks

The height can be set using standard CSS units such as pixels (e.g., "200px"), percentages (e.g., "50%"), or keywords like "Auto". If "Auto" is specified, the menu height will adjust based on its content.

KeyTip

Gets or sets the key tip text for the backstage button 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 backstage button. Defaults to an empty string.

Remarks

The KeyTip property allows you to define a keyboard shortcut for the backstage button in the SfRibbon component. When key tips are enabled, pressing the assigned key combination allows users to quickly access the backstage menu.

Template

Sets a template that defines the appearance of the backstage menu view.

Declaration

public RenderFragment Template { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing the template for the backstage view. The default is null.

Remarks

This property specifies the template used to render the appearance of the backstage menu view. The template can only be set, not retrieved. If you need to modify an existing template, you should create a new Microsoft.AspNetCore.Components.RenderFragment based on the desired changes.

Text

Gets or sets the text to be displayed in the Backstage Menu of the SfRibbon component.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A string that represents the text content of the Backstage Menu. The default value is “File”.

Remarks

The text displayed in the Backstage Menu can be customized to show relevant labels or instructions to the user.

TooltipSettings

Gets or sets the tooltip for the Backstage menu.

Declaration

public RibbonTooltipSettings TooltipSettings { get; set; }

Property Value

Type	Description
RibbonTooltipSettings	An instance of RibbonTooltipSettings representing the tooltip for the Backstage menu.

Remarks

The tooltip provides additional information about the Backstage menu when hovered over.

Visible

Gets or sets a value indicating whether the Backstage Menu is visible.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that indicates the visibility of the Backstage Menu. The default value is false.

Remarks

Set this property to false to hide the Backstage Menu. This can be useful for conditional display based on user actions.

Width

Gets or sets the width of the Backstage Menu in the SfRibbon component.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	A string that specifies the width of the Backstage Menu. The default value is "auto".

Remarks

Similar to height, the width can be specified in various CSS units including pixels (e.g., "300px"), percentages (e.g., "75%"), or "Auto". The "Auto" value will make the menu width adjust automatically based on its content.

Methods

AddBackstageItemsAsync(List<BackstageMenuItem>, String, Boolean, Boolean)

Adds one or more items to the Backstage menu in the SfRibbon component.

Declaration

public Task AddBackstageItemsAsync(List<BackstageMenuItem> items, string target, bool isAfter, bool isUniqueId = false)

Parameters

Type	Name	Description
System.Collections.Generic.List<BackstageMenuItem>	items	A list of items to add, each represented as a BackstageMenuItem.
System.String	target	The target item text where the new items should be placed. If isUniqueId is set to true, this property will be considered as the ID value.
System.Boolean	isAfter	Determines whether items should be added after the target item. Set to false to add before.
System.Boolean	isUniqueId	Indicates whether target is treated as a unique ID.

Returns

Type	Description
System.Threading.Tasks.Task	A task representing the asynchronous operation.

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)

HideBackstageAsync()

Hides the Backstage menu in the SfRibbon component asynchronously.

Declaration

public void HideBackstageAsync()

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnInitializedAsync()

RemoveBackstageItemAsync(List<BackstageMenuItem>, Boolean)

Removes one or more items from the Backstage menu in the SfRibbon component.

Declaration

public Task RemoveBackstageItemAsync(List<BackstageMenuItem> items, bool isUniqueId = false)

Parameters

Type	Name	Description
System.Collections.Generic.List<BackstageMenuItem>	items	A list of BackstageMenuItem objects representing the items to be removed from the Backstage menu.
System.Boolean	isUniqueId	Optional. Indicates whether the list of items contains unique IDs. Defaults to false.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Remarks

This method allows you to remove multiple Backstage menu items at once. If isUniqueId is set to true, the method will use the ID property of the items for removal. Otherwise, it will use other properties like Text for matching and removal.

ShowBackstageAsync()

Displays the Backstage menu in the SfRibbon component asynchronously.

Declaration

public void ShowBackstageAsync()