Class MenuItem
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class MenuItem : BaseEntity, IMenuItem, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IMenuItem>Constructors
MenuItem()
Declaration
public MenuItem()Properties
ActivateOnLoad
Indicates this command is activated when the system is loaded
Declaration
public bool ActivateOnLoad { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
ActiveOnAllMenus
Indicates this command should appear on all menus created for this role.
This is often used to provide consistent access to common commands such as Save from everywhere.
Declaration
public bool ActiveOnAllMenus { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
AddToMenuBar
This indicates the command should also appear in the menu bar at the top right near the user menu.
If you also mark this command as invisible then it will only appear in the menu bar, and not on the main menu itself.
Declaration
public bool AddToMenuBar { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
AddToQuickAccess
This indicates the command should also appear in the quick access at the top left of the app.
If you also mark this command as invisible then it will only appear in the quick access, and not on the main menu itself.
Declaration
public bool AddToQuickAccess { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
AddToSimplifiedMenu
By default the menu shows all commands. However if you start selecting commands as being part of a simplified set, then by default the menu will show the simplified set only. When you toggle the simplified menu you can then see all the other commands as well.
Declaration
public bool AddToSimplifiedMenu { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
AddToUserMenuBar
This indicates the command should also appear in the user menu at the top right.
If you also mark this command as invisible then it will only appear in the user menu, and not on the main menu itself.
Declaration
public bool AddToUserMenuBar { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
GroupHelpURL
A custom url for help on this group
Declaration
[StringLength(500)]
public string GroupHelpURL { get; set; }Property Value
| Type | Description |
|---|---|
| string |
GroupIndex
Holds the position of this group within the menu
Declaration
public short GroupIndex { get; set; }Property Value
| Type | Description |
|---|---|
| short |
GroupName
The user friendly name of the group this command resides within.
Declaration
[StringLength(500)]
public string GroupName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ItemDescription
The user friendly description for this item command
Declaration
public string ItemDescription { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ItemHelpURL
A custom url for help on this command
Declaration
[StringLength(500)]
public string ItemHelpURL { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ItemID
The actual command you want this menu item to invoke. See our list of all standard commands ( https://help.lemonedge.com/all-commands/).
Declaration
public Guid ItemID { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
ItemIconID
The system or ICustomImage icon to use for this command on the menu
Declaration
public Guid ItemIconID { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
ItemIndex
Holds the position of this command within the group
Declaration
public short ItemIndex { get; set; }Property Value
| Type | Description |
|---|---|
| short |
ItemName
The user friendly name of this command
Declaration
[Required]
[StringLength(500)]
public string ItemName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ItemParam
Any custom parameters for configuring this command ItemID
Declaration
public string ItemParam { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ItemTooltip
The user friendly description for this item command which will only be shown as a tooltip
Declaration
[StringLength(1000)]
public string ItemTooltip { get; set; }Property Value
| Type | Description |
|---|---|
| string |
MenuIndex
Holds the position of this menu in the root menus
Declaration
public short MenuIndex { get; set; }Property Value
| Type | Description |
|---|---|
| short |
MenuName
The user friendly name of this root menu
Declaration
[StringLength(500)]
public string MenuName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
RoleID
[Key] Links to IRole. The parent role this menu item belongs to
Declaration
public Guid RoleID { get; set; }Property Value
| Type | Description |
|---|---|
| Guid |
RoleID_Label
Declaration
public string RoleID_Label { get; set; }Property Value
| Type | Description |
|---|---|
| string |
RoleID_Label_Silent
Declaration
[NotMapped]
public string RoleID_Label_Silent { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Visible
Indicates if this command should be visible on the main menu.
This is usually used to hide the command from the main menu and make it visible in the user menu, or quick access, only.
Declaration
public bool Visible { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | src |
Overrides
CopyFromSource(IMenuItem)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(IMenuItem source)Parameters
| Type | Name | Description |
|---|---|---|
| IMenuItem | source | The source object to copy all values from. |
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |