clsMenuPage¶
Represents one navigable page (MENU_PAGE) — its link text, owning application, favorite-display name, and the per-capability toolbar flags/tooltips (print, download, help, save, insert, delete, save-preferences) that the presentation layer renders around the page. clsMenuItem places a page into a category, and clsMenuAuthorizedItemCollection denormalizes this data into the read-only authorization projection.
Purpose¶
- Owns the identity, link, and toolbar-capability configuration of one page, persisted to MENU_PAGE.
- Supplies the
PageLinkvalue matched by page-lookup and page-authorization logic (BR-MENU-009, OP-MENU-03). - Lazily loads its owning
clsApplicationCodeon first access toApplication(BR-MENU-024). - Falls back to
PageNamewhen no favorite-specific name is stored (BR-MENU-023).
Context¶
- Namespace:
SAIF.Business.Menu - Assembly/package:
SAIF.Business.Menu(SAIF.BOF.Presentation.Web.Infragistics111NuGet package)
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| MenuPageSeqNum | Property MenuPageSeqNum As Decimal |
Server-assigned surrogate key from the MENU_PAGE_SEQ sequence (BR-MENU-014). |
| PageName | Property PageName As String |
Display name of the page. |
| FavoriteName | Property FavoriteName As String |
Label used when this page is favorited; when blank, FavoritePageName falls back to PageName (BR-MENU-023). |
| FavoritePageName | ReadOnly Property FavoritePageName As String |
Effective favorite label: FavoriteName if set, otherwise PageName (BR-MENU-023). |
| PageLink | Property PageLink As String |
The page URL matched (trimmed, case-insensitive, query-string-stripped for non-exact lookups) during navigation and authorization lookups (BR-MENU-009). |
| ApplicationCode | Property ApplicationCode As String |
Foreign key identifying the owning clsApplicationCode. |
| Application | ReadOnly Property Application As clsApplicationCode |
Lazily loads the owning application on first access (BR-MENU-024). |
| IsDisplaySavePreferences | Property IsDisplaySavePreferences As Boolean |
Toolbar flag controlling whether the save-preferences control is shown, persisted as Y/N (BR-MENU-019). |
| IsDisplayPrint | Property IsDisplayPrint As Boolean |
Toolbar flag controlling whether the print control is shown (BR-MENU-019). |
| IsDisplayDownload | Property IsDisplayDownload As Boolean |
Toolbar flag controlling whether the download control is shown (BR-MENU-019). |
| IsDisplayHelp | Property IsDisplayHelp As Boolean |
Toolbar flag controlling whether the help control is shown (BR-MENU-019). |
| IsDisplaySave | Property IsDisplaySave As Boolean |
Toolbar flag controlling whether the save control is shown (BR-MENU-019). |
| IsDisplayInsert | Property IsDisplayInsert As Boolean |
Toolbar flag controlling whether the insert control is shown (BR-MENU-019). |
| IsDisplayDelete | Property IsDisplayDelete As Boolean |
Toolbar flag controlling whether the delete control is shown (BR-MENU-019). |
| PrintToolTip | Property PrintToolTip As String |
Tooltip text shown for the print control. |
| DownloadToolTip | Property DownloadToolTip As String |
Tooltip text shown for the download control. |
| SaveToolTip | Property SaveToolTip As String |
Tooltip text shown for the save control. |
| InsertToolTip | Property InsertToolTip As String |
Tooltip text shown for the insert control. |
| DeleteToolTip | Property DeleteToolTip As String |
Tooltip text shown for the delete control. |
| NewMenuPage | Shared Function NewMenuPage(dpi As IDataPortalInfo) As clsMenuPage |
Factory that creates a new page ready for Save; the key is server-assigned on insert (BR-MENU-014). |
| GetMenuPage | Shared Function GetMenuPage(dpi As IDataPortalInfo, menuPageSeqNum As Decimal) As clsMenuPage |
Factory that retrieves one page by its key (SQL-024). |
| Save | Sub Save() |
Persists the object via insert or update depending on new/dirty state, stamping UPDATE_DATE/UPDATE_USER (BR-MENU-016, BR-MENU-018). |
| Delete | Sub Delete() |
Removes the row and returns the object to a new, unsaved state (BR-MENU-022). |
Inherited public members¶
Members in this section are inherited from clsBusinessBase in SAIF.Framework.Core (delivered by the SAIF.BOF.Framework package). They are available on this type through inheritance.
| Member | Signature | Purpose | Origin |
|---|---|---|---|
| Rules | ReadOnly Property Rules As clsRulesManager |
Exposes the object's rule manager, used to register and evaluate validation rules.† | SAIF.Framework.Core — clsBusinessBase |
| BeginEdit | Sub BeginEdit() |
Begins an editable transaction on the object, snapshotting current state for a later cancel.† | SAIF.Framework.Core — clsBusinessBase |
| CancelEdit | Sub CancelEdit() |
Reverts the object to the state captured by the most recent BeginEdit.† |
SAIF.Framework.Core — clsBusinessBase |
| ApplyEdit | Sub ApplyEdit() |
Commits the in-progress edit, discarding the BeginEdit snapshot.† |
SAIF.Framework.Core — clsBusinessBase |
| SetPreviousLink | Sub SetPreviousLink(item As ILinkItem) |
Sets the previous node in a doubly linked list of business objects.† | SAIF.Framework.Core — clsBusinessBase |
| SetNextLink | Sub SetNextLink(item As ILinkItem) |
Sets the next node in a doubly linked list of business objects.† | SAIF.Framework.Core — clsBusinessBase |
| InsertLinkAfter | Sub InsertLinkAfter(item As ILinkItem) |
Inserts the given item immediately after this object in a linked sequence.† | SAIF.Framework.Core — clsBusinessBase |
Related documentation¶
Note: Statements marked with
*were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with†were retrieved from dependency library documentation via the Legends CLI RAG service. They describe inherited behavior from the indicated origin library and should be verified if the dependency version changes.
Sources¶
- SAIF.Business.Menu/clsMenuPage.vb