PageInfo Properties

The PageInfoAttrs associated with this item.

The BasePageID of the page, if a base page is used, else null. Base pages provide a basic inheritance capability allowing other pages to inherit a base page's page elements and properties. Base pages themselves cannot be instantiated. Check IsBasePage to determine if this page is a base page.

The clone status of this pageinfo object.

The component to use to render this page. This is the ID to the Template used on the page.

Gets/Sets the Device value. Note that this is the SAME value as ParamText and is preferred over ParamText.

Device specification on pages allows the application to tailor pages to the real-estate limitation of different devices such as mobile and tablet devices.

Page Overloading can achieved by specifying Device and/or Priority. When a user logs in with roles that allow access to multiple pages with the same MOP then Device and Priority are used to determine which of these pages is to be used. If a particular Device matches the current device then that page is favored. If multiple pages with the same (or no) Device are available then Priority is used to disambiguate with the highest Priority number favored.

The PageElementInfos collection of PageElementInfo objects for this page. This object is not loaded until it is requested via this method.

Every page must have at least one PageElementInfo associated with it. Note, however, that one or more PageElementInfo objects may be inherited from the page's base page (BasePageID).

Returns the page_id

True if this page is a base page. Base pages provide a basic inheritance capability allowing other pages to inherit a base page's page elements and properties. Base pages themselves cannot be instantiated. If this page uses a base page then BasePageID will be set.

The unique key to the Mapper to use for this page.

The module for the page. This forms the 1st half of the MOP, for example "company" in "company!detail" or "company!list".

The Moniker is intended to be unique at least within the module. It is used to differentiate between two pages with the same MOP. For example, there could be a general contact!detail page for most users and another contact!detail page for managers only. The Moniker provides a way to differentiate between the two.

The Module-Page of the form [module]![page], for example "company!detail" or "company!list". Use Module and Name to get/set the individual parts of the MOP.

The name of the page. This forms the 2nd half of the MOP, for example "detail" and "list" in "company!detail" and "company!list" respectively.

The unique ID for this page. The PageID is provided for internal use and is not normally used by application implementations.

Gets the page-instance-specific Properties for this GLOBAL PageInfo object. An instance of a page object, typically implementing IPageTemplate, references a GLOBAL copy of the corresponding PageInfo object for the page and any changes to its properties will affect other users and other instances of the page. The properties collection returned by this method, however, is unique to this page instance and is not shared across page instances for this or for other users. Upon initial access the returned collection is instantiated and initialized from the page's GLOBAL PageInfo object (generally reflecting the meta-data). Changes to the collection are NOT passed through to the GLOBAL object.

Gets/Sets the Device value. ParamText is provided for backward compatability. (Deprecated)

The Priority is used to determine which page to use when a particular user has access to multiple pages with the same MOP. In such a case the MOP with the highest priority is used. This is called Page Overloading.

For example, there could be a general contact!detail page for most users and another contact!detail page for managers only. If so, priority would typically be set higher on the manager page so that a manager (who is presumably also a user) gets the manager page when navigating to contact!detail.

Page Overloading can achieved by specifying Device and/or Priority. When a user logs in with roles that allow access to multiple pages with the same MOP then Device and Priority are used to determine which of these pages is to be used. If a particular Device matches the current device then that page is favored. If multiple pages with the same (or no) Device are available then Priority is used to disambiguate with the highest Priority number favored. A further mechanism for page overloading is available by marking a page as TenantSpecific. Tenant-specific pages are favored over their non-tenant-specific counterparts.

The page's Properties collection.

The platform Template to use for this page. The template's ID is ComponentID. The template should implement the IPageTemplate interface (typically by deriving from NetQuarry.TemplateKernel, access to which requires referencing the EAP.WebHost assembly). Custom templates can be created, but generally the following platform-provided templates are used:

• TabbedSubformTemplate - Provides a horizontally split screen with a bottom pane presenting multiple tabs related to the data in the top pane.
• ExpandedSubformTemplate - Provides a horizontally split screen with a bottom pane vertically presenting multiple expandable items related to the data in the top pane.
• WizTemplate - Implements IWizardTemplate and provides a multi-page wizard typically used for creating one or more new items.
• ConsoleTemplate - Implements IConsoleTemplate and provides a user console with multiple data panes manipulable by the user.

The page's localized text.

Get the scaled version of the IAppContext object.