Interface IMenuItem

The system entity for a menu item, which holds the commands that are available on the main menu in the ui for users to interact with

See https://help.lemonedge.com/help/open-architecture/admin/roles/menu-view.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.MenuItems, "dbo.LT_MenuItems", "MenuItem", IsStandingDataEntity = true, CustomToString = true)]
[DefaultEntityIcon(ImageType.Menu)]
[EntityIndex(Name = "Role", ColumnNames = new string[] { "RoleID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface IMenuItem : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

ActivateOnLoad

Indicates this command is activated when the system is loaded

Declaration
[EntityProperty(SQLType.Bit, false)]
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
[EntityProperty(SQLType.Bit, false, "0")]
[EntityKeyProperty]
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
[EntityProperty(SQLType.Bit, false)]
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
[EntityProperty(SQLType.Bit, false)]
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
[EntityProperty(SQLType.Bit, false, "0")]
[HardCodedDefaultValueOnNew("false")]
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
[EntityProperty(SQLType.Bit, false, "0")]
bool AddToUserMenuBar { get; set; }
Property Value
Type Description
bool

GroupHelpURL

A custom url for help on this group

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
string GroupHelpURL { get; set; }
Property Value
Type Description
string

GroupIndex

Holds the position of this group within the menu

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityKeyProperty]
short GroupIndex { get; set; }
Property Value
Type Description
short

GroupName

The user friendly name of the group this command resides within.

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
string GroupName { get; set; }
Property Value
Type Description
string

ItemDescription

The user friendly description for this item command

Declaration
[EntityProperty(SQLType.NVarChar, true)]
string ItemDescription { get; set; }
Property Value
Type Description
string

ItemHelpURL

A custom url for help on this command

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
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
[EntityProperty(SQLType.UniqueIdentifier, false)]
Guid ItemID { get; set; }
Property Value
Type Description
Guid

ItemIconID

The system or ICustomImage icon to use for this command on the menu

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
Guid ItemIconID { get; set; }
Property Value
Type Description
Guid

ItemIndex

Holds the position of this command within the group

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityKeyProperty]
short ItemIndex { get; set; }
Property Value
Type Description
short

ItemName

The user friendly name of this command

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[Required]
string ItemName { get; set; }
Property Value
Type Description
string

ItemParam

Any custom parameters for configuring this command ItemID

Declaration
[EntityProperty(SQLType.NVarChar, true)]
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
[EntityProperty(SQLType.NVarChar, 1000, true)]
string ItemTooltip { get; set; }
Property Value
Type Description
string

MenuIndex

Holds the position of this menu in the root menus

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityKeyProperty]
short MenuIndex { get; set; }
Property Value
Type Description
short

MenuName

The user friendly name of this root menu

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
string MenuName { get; set; }
Property Value
Type Description
string

RoleID

[Key] Links to IRole. The parent role this menu item belongs to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Roles, "ID", SingleJoinType.One, "Role", "Menu Items", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[EntityKeyProperty]
Guid RoleID { get; set; }
Property Value
Type Description
Guid

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
[EntityProperty(SQLType.Bit, false)]
bool Visible { get; set; }
Property Value
Type Description
bool

Extension Methods

See Also