Class NavMenuItem
The nav menu items under a NavMenu. /// NOTE: The data is structured to support a recursive navigation menu, however this LymeTemplateApp application only supports single level dropdown navigation at the moment.
Inheritance
Namespace: LymeTemplateApi.Models
Assembly: LymeTemplateApi.Models.dll
Syntax
public class NavMenuItem : objectProperties
Active
Used by the client app. Not mapped to a DB record.
Declaration
public bool Active { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Deleted
Used by the client app. Not mapped to a DB record.
Declaration
public bool Deleted { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Description
The text that will appear in a card menu or accessibility interfaces.
Declaration
public string? Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
Disabled
When true, the item still should appear in the nav menu but greyed out or stricken through.
Declaration
public bool? Disabled { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
DividerBelow
Indicates whether a line should appear below this menu item.
Declaration
public bool? DividerBelow { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
HasChildren
Used only for the mapping in the usp_GetFlattenedNavMenu procedure
Declaration
public bool? HasChildren { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Hidden
Whether a menu item is hidden.
Declaration
public bool? Hidden { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
HideFromRoles
A comma separated list of roles for which to hide this NavMenuItem.
Declaration
public string? HideFromRoles { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
HideOnHomeMenu
When true, the item will not appear on the Home Menu front-end component.
Declaration
public bool? HideOnHomeMenu { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Href
The web address that the navigation item should take you to. These will be opened in a new tab/window depending on the user's browser preferences.
Declaration
public string? Href { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
Icon
The optional icon that
Declaration
public string? Icon { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
Id
Primary key
Declaration
public int Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
IsExpanded
Used by the client app. Not mapped to a DB record.
Declaration
public bool IsExpanded { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Level
Used only for the mapping in the usp_GetFlattenedNavMenu procedure
Declaration
public int? Level { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
NavMenu
EF Navigation property
Declaration
public NavMenu NavMenu { get; set; }Property Value
| Type | Description |
|---|---|
| NavMenu |
NavMenuId
The Id of the Navigation Menu this item belongs to.
Declaration
public int NavMenuId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
NavMenuItems
The NavMenuItem's Child menu items.
Declaration
public IList<NavMenuItem>? NavMenuItems { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<IList<NavMenuItem>> |
NotificationCount
This is a field where the NotificationCount will be stored. For client use only.
Declaration
public int? NotificationCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
NotificationCountKeyName
The RealTimeData class contains a key/value paired list of Notifications. If the notificationKeyName equals the value of this field, that notification bubble will appear next to the nav menu item.
Declaration
public string? NotificationCountKeyName { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
ParentNavMenuItem
EF Navigation Property
Declaration
public NavMenuItem ParentNavMenuItem { get; set; }Property Value
| Type | Description |
|---|---|
| NavMenuItem |
ParentNavMenuItemId
The ID of the Parent NavMenu Item. If this value is null, it is at the top level of the navigation menu.
Declaration
public int? ParentNavMenuItemId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
RestrictRoles
A comma separated list of roles. This currently is only working at the top level of the navigation (not child navmenu items)
Declaration
public string? RestrictRoles { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
RouterLink
The route that will be navigated to once the navigation item is clicked. The angular router's navigateByUrl method is currently used to navigate a user to the appropriate route.
Declaration
public string? RouterLink { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |
Sort
The sort order.
Declaration
public int Sort { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Text
The text that will appear on the navigation menu item.
Declaration
public string? Text { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.String> |