Class ApplicationMenuItem

Inheritance
System.Object
ApplicationMenuItem
Implements
Namespace: Volo.Abp.UI.Navigation
Assembly: Volo.Abp.UI.Navigation.dll
Syntax
public class ApplicationMenuItem : object, IHasMenuItems

Constructors

ApplicationMenuItem(String, String, String, String, Int32, Object, String, String, String)

Declaration
public ApplicationMenuItem(string name, string displayName, string url = null, string icon = null, int order = null, object customData = null, string target = null, string elementId = null, string cssClass = null)
Parameters
Type Name Description
System.String name
System.String displayName
System.String url
System.String icon
System.Int32 order
System.Object customData
System.String target
System.String elementId
System.String cssClass

Fields

DefaultOrder

Default Order value of a menu item.

Declaration
public const int DefaultOrder = null
Field Value
Type Description
System.Int32

Properties

CssClass

Can be used to render the element with extra CSS classes.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

CustomData

Can be used to store a custom object related to this menu item. Optional.

Declaration
public object CustomData { get; set; }
Property Value
Type Description
System.Object

DisplayName

Display name of the menu item.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

ElementId

Can be used to render the element with a specific Id for DOM selections.

Declaration
public string ElementId { get; set; }
Property Value
Type Description
System.String

Icon

Icon of the menu item if exists.

Declaration
public string Icon { get; set; }
Property Value
Type Description
System.String

IsDisabled

Can be used to disable this menu item.

Declaration
public bool IsDisabled { get; set; }
Property Value
Type Description
System.Boolean

IsLeaf

Returns true if this menu item has no child Items.

Declaration
public bool IsLeaf { get; }
Property Value
Type Description
System.Boolean

Items

Declaration
public ApplicationMenuItemList Items { get; }
Property Value
Type Description
ApplicationMenuItemList

Name

Unique name of the menu in the application.

Declaration
public string Name { get; }
Property Value
Type Description
System.String

Order

The Display order of the menu. Default value: 1000.

Declaration
public int Order { get; set; }
Property Value
Type Description
System.Int32

Target

Target of the menu item. Can be null, "_blank", "_self", "_parent", "_top" or a frame name for web applications.

Declaration
public string Target { get; set; }
Property Value
Type Description
System.String

Url

The URL to navigate when this menu item is selected.

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

Methods

AddItem(ApplicationMenuItem)

Adds a ApplicationMenuItem to Items.

Declaration
public ApplicationMenuItem AddItem(ApplicationMenuItem menuItem)
Parameters
Type Name Description
ApplicationMenuItem menuItem

ApplicationMenuItem to be added
Returns
Type Description
ApplicationMenuItem

This ApplicationMenuItem object

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

Extension Methods