View Source

Class MenuItem

A context menu item

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Models.Trees

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "menuItem", Namespace = "")]
public class MenuItem

Constructors

MenuItem()

Declaration

public MenuItem()

MenuItem(String, String)

Declaration

public MenuItem(string alias, string name)

Parameters

Type	Name	Description
System.String	alias
System.String	name

MenuItem(String, ILocalizedTextService)

Declaration

public MenuItem(string alias, ILocalizedTextService textService)

Parameters

Type	Name	Description
System.String	alias
ILocalizedTextService	textService

MenuItem(IAction, String)

Create a menu item based on an IAction definition

Declaration

public MenuItem(IAction action, string name = "")

Parameters

Type	Name	Description
IAction	action
System.String	name

Properties

Action

Declaration

[IgnoreDataMember]
public IAction Action { get; set; }

Property Value

Type	Description
IAction

AdditionalData

A dictionary to support any additional meta data that should be rendered for the node which is useful for custom action commands such as 'create', 'copy', etc...

Declaration

[DataMember(Name = "metaData")]
public Dictionary<string, object> AdditionalData { get; }

Property Value

Type	Description
Umbraco.Cms.Core.Dictionary<System.String, System.Object>

Remarks

We will also use the meta data collection for dealing with legacy menu items (i.e. for loading custom URLs or executing custom JS).

Alias

Declaration

[DataMember(Name = "alias", IsRequired = true)]
[Required]
public string Alias { get; set; }

Property Value

Type	Description
System.String

Icon

Icon to use at action menu item.

Declaration

[DataMember(Name = "icon")]
public string Icon { get; set; }

Property Value

Type	Description
System.String

Name

Declaration

[DataMember(Name = "name", IsRequired = true)]
[Required]
public string Name { get; set; }

Property Value

Type	Description
System.String

OpensDialog

Used in the UI to inform the user that the menu item will open a dialog/confirmation

Declaration

[DataMember(Name = "opensDialog")]
public bool OpensDialog { get; set; }

Property Value

Type	Description
System.Boolean

SeparatorBefore

Ensures a menu separator will exist before this menu item

Declaration

[DataMember(Name = "separator")]
public bool SeparatorBefore { get; set; }

Property Value

Type	Description
System.Boolean

TextDescription

Declaration

[DataMember(Name = "textDescription")]
public string TextDescription { get; set; }

Property Value

Type	Description
System.String

UseLegacyIcon

Used in the UI to indicate whether icons should be prefixed with "icon-". If not legacy icon full icon name should be specified.

Declaration

[DataMember(Name = "useLegacyIcon")]
public bool UseLegacyIcon { get; set; }

Property Value

Type	Description
System.Boolean

Methods

ExecuteJsMethod(String)

Adds the required meta data to the menu item so that angular knows to attempt to call the Js method.

Declaration

public void ExecuteJsMethod(string jsToExecute)

Parameters

Type	Name	Description
System.String	jsToExecute

LaunchDialogUrl(String, String)

Sets the menu item to display a dialog based on a URL path in an iframe

Declaration

public void LaunchDialogUrl(string url, string dialogTitle)

Parameters

Type	Name	Description
System.String	url
System.String	dialogTitle

LaunchDialogView(String, String)

Sets the menu item to display a dialog based on an angular view path

Declaration

public void LaunchDialogView(string view, string dialogTitle)

Parameters

Type	Name	Description
System.String	view
System.String	dialogTitle

NavigateToRoute(String)

Sets the menu item to navigate to the specified angular route path

Declaration

public void NavigateToRoute(string route)

Parameters

Type	Name	Description
System.String	route