IPageTemplate Interface |
The standard interface for page templates.
See IPageTemplate2, supported by some page templates, for access to extended capabilities.
See IPageFixedPurpose, support by certain other pages.
By far the most common page templates are:
- 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 (non-Bootstrap applications).
- BootConsoleTemplate - Implements IConsoleTemplate and provides a user console with multiple data panes manipulable by the user (Bootstrap applications).
Namespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe IPageTemplate type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AppContext |
Gets the IAppContext object.
|
| AsConsole |
Access this page using the IConsoleTemplate interface. This will return null for all non-console pages. |
| AsWizard |
Access this page using the IWizardTemplate interface. This will return null for all non-wizard pages. |
| IsMultiElement |
Gets whether or not this template a multi-element template (e.g. ConsoleTemplate) vs. a single-element template (e.g. TabbedSubformTemplate).
Multi-element templates can have multiple peer slots on the page. Typically elements hosted on a multi-element template
get certain settings from their PageElementInfo rather than the PageInfo.
|
| MainMapper |
Get the main IMapperfor this page. Generally this corresponds to the IMapper used by the renderer assigned to the main slot.
For multi-element pages (e.g. Console and Wizard pages), you can use AsConsole and AsWizard to get the
corresponding interface which provide access additional mappers.
Note that this may be null for certain page types and/or stages in a page's life-cycle and should be tested accordingly. |
| MainRenderer |
Get the main renderer for this implementing the IRenderer interface.
Generally this corresponds to the PageElementInfo assigned to the main slot.
For multi-element pages (e.g. Console and Wizard pages), you can use AsConsole and AsWizard to get the
corresponding interface which provide access to additional renderers.
Note that this may be null for certain page types and/or stages in a page's life-cycle and should be tested accordingly. |
| PageInfo |
Get the PageInfo object for this page.
|
| PageProperties |
Gets the page-instance-specific Properties for the page's GLOBAL PageInfo object.
This collection is normally be accessed by calling PageProperties, not directly.
Upon first access, the collection is created an initialized from the page's GLOBAL PageInfo properties.
|
Methods| Name | Description | |
|---|---|---|
 | AddFrameworkScriptRef |
Add a javascript file reference that depends on framework script (e.g. jQuery or Bootstrap).
|
| FireEvent |
Fire an extension event on the page.
|
| GetClonedPageInfo |
Gets the cloned PageInfo object for this page. If the page's PageInfo object has not net been cloned
then this method clones it and sets the clone back on the page. If the page's PageInfo object has already been cloned
then that object is returned. In either case the returned PageInfo object will have the ClonedByUser status.
Once the page's PageInfo has been cloned and set back on the page, the cloned PageInfo object can be freely
manipulated without affecting other requests by the current, or other, users.
Note that cloning the PageInfo and setting back on the page does not update any IMapper objects already set up with the original PageInfo object. However, any IMapper objects set up after the operation will use the cloned PageInfo. Performing the operation during the ApplicationPageInit event (PageInit(IAppContext, ApplicationPageArgs)) sets up the clone very early in the page life-cycle and ensure that the page's IMapper objects will use the cloned PageInfo. |
See Also