Class SfMenu<TValue>

Menu is a graphical user interface that serve as navigation headers for your application.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>

SfMenu<TValue>

Namespace: Syncfusion.Blazor.Navigations

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfMenu<TValue> : SfMenuBase<TValue>, IMenu

Type Parameters

Name	Description
TValue

Constructors

SfMenu()

Declaration

public SfMenu()

Properties

HamburgerMode

Specifies whether to enable / disable the hamburger mode in Menu.

Declaration

public bool HamburgerMode { get; set; }

Property Value

Type	Description
System.Boolean

Orientation

Specified the orientation of Menu whether it can be horizontal or vertical.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation

Target

Specifies target element to open/close Menu while click in Hamburger mode.

Declaration

public string Target { get; set; }

Property Value

Type	Description
System.String

Title

Specifies the title text for hamburger mode in Menu.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

Close()

Closes the Menu if it is opened in hamburger mode.

Declaration

public Task Close()

Returns

Type	Description
System.Threading.Tasks.Task

GetItemIndex(TValue, Boolean)

This method is used to get the index of the menu item in the Menu based on the argument.

Declaration

public List<int> GetItemIndex(TValue item, bool isUniqueId = false)

Parameters

Type	Name	Description
TValue	item	Item be passed to get the index.
System.Boolean	isUniqueId	Set true if it is a unique id.

Returns

Type	Description
System.Collections.Generic.List<System.Int32>

InsertAfter(List<TValue>, String, Boolean)

It is used to insert the menu items after the specified menu item text.

Declaration

public void InsertAfter(List<TValue> items, string text, bool isUniqueId = false)

Parameters

Type	Name	Description
System.Collections.Generic.List<TValue>	items	Text items that needs to be inserted.
System.String	text	Text item before that the new Items will be inserted.
System.Boolean	isUniqueId	Set true if it is a unique id.

InsertBefore(List<TValue>, String, Boolean)

It is used to insert the menu items before the specified menu item text.

Declaration

public void InsertBefore(List<TValue> items, string text, bool isUniqueId = false)

Parameters

Type	Name	Description
System.Collections.Generic.List<TValue>	items	Text items that needs to be inserted.
System.String	text	Text item after that the new Items will be inserted.
System.Boolean	isUniqueId	Set true if it is a unique id.

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.Navigations.Internal.SfMenuBase<TValue>.OnParametersSetAsync()

Open()

Used to open the Menu in hamburger mode.

Declaration

public Task Open()

Returns

Type	Description
System.Threading.Tasks.Task

RemoveItems(List<String>, Boolean)

It is used to remove the menu items from the Menu based on the items text.

Declaration

public void RemoveItems(List<string> items, bool isUniqueId = false)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	items	Text items that needs to be removed.
System.Boolean	isUniqueId	Set true if it is a unique id.

SetItem(TValue, String, Boolean)

This method is used to set the menu item in the Menu based on the argument.

Declaration

public void SetItem(TValue item, string itemText = null, bool isUniqueId = false)

Parameters

Type	Name	Description
TValue	item	Represents the modified item.
System.String	itemText	Represents the Text of the existing Item which needs to be replaced with provided Item.
System.Boolean	isUniqueId	Set true if the provided text is a unique id.