IAppMap¶
Contract describing how a consuming application maps itself into the BOL menu: its name, its menu category, and the page identifiers used to highlight the current item. BasicAppMap is the only implementation.
Purpose¶
- Give views and consumers a uniform shape for application menu mapping.
Context¶
- Namespace:
BolMiddleware.Models.MenuModels - Assembly/package:
BolMiddleware
Public members¶
| Member | Signature | Purpose |
|---|---|---|
ApplicationName |
string ApplicationName { get; set; } |
Name of the consuming application in the BOL menu. |
AppMenuCategory |
string AppMenuCategory { get; set; } |
Menu category code used to filter the top menu. |
PageIds |
Dictionary<string,string> PageIds { get; set; } |
Map from request path to page identifier. |
Behavioral notes¶
- The scoped
IAppMapregistration returns an unbound defaultBasicAppMap.
Constraints and usage notes¶
- Views read
IOptions<BasicAppMap>instead.
Sources¶
- src/BolMiddleware/Models/MenuModels/IAppMap.cs
- src/BolMiddleware/BolRazorLayoutStartup.cs