%CSP.Util.PageInstance

class %CSP.Util.PageInstance extends %Library.RegisteredObject, %XML.Adaptor

Desribes an instance of an AutoPage.
This is a transient object that exists while an AutoPage is being rendered. It describes the layout for an AutoPage. It also provides a container for any page-related variables.

Property Inventory

• Address
• IDValues
• PageClass
• PageVars
• Panes
• Title

Method Inventory

• MakeFramePopupLink()
• MakeLink()
• MakePopupLink()
• MakeRedirectLink()

Properties

property Address as %String (MAXLEN = 200);

Canonical address used to find this page (e.g., "Home,Configuration").

Property methods: AddressDisplayToLogical(), AddressGet(), AddressIsValid(), AddressLogicalToDisplay(), AddressLogicalToOdbc(), AddressNormalize(), AddressSet()

property IDValues as %String [ MultiDimensional ];

An array (integer-subscripted) of values use to identify any objects used within a page (such as the ID for an object or parameters for a query).
These are taken out of the incoming URL using the $IDn parameter.

Property methods: IDValuesDisplayToLogical(), IDValuesGet(), IDValuesIsValid(), IDValuesLogicalToDisplay(), IDValuesLogicalToOdbc(), IDValuesNormalize(), IDValuesSet()

property PageClass as %String (MAXLEN = 128, XMLPROJECTION = "none");

Name of CSP class hosting this page

Property methods: PageClassDisplayToLogical(), PageClassGet(), PageClassIsValid(), PageClassLogicalToDisplay(), PageClassLogicalToOdbc(), PageClassNormalize(), PageClassSet()

property PageVars as %String [ MultiDimensional ];

An array of page-directed variables, subscripted by name and number (as a URL parameter is placed within the Request object).
These are taken out of the incoming URL query: any value starting with $ is assumed to be a page variable.

Property methods: PageVarsDisplayToLogical(), PageVarsGet(), PageVarsIsValid(), PageVarsLogicalToDisplay(), PageVarsLogicalToOdbc(), PageVarsNormalize(), PageVarsSet()

property Panes as array of Pane;

An array of named Pane objects that describe the various panes for a page.

Property methods: PanesBuildValueArray(), PanesCollectionToDisplay(), PanesCollectionToOdbc(), PanesDisplayToCollection(), PanesGet(), PanesGetObject(), PanesGetObjectId(), PanesGetSwizzled(), PanesIsValid(), PanesOdbcToCollection(), PanesSet(), PanesSetObject(), PanesSetObjectId()

property Title as %String (MAXLEN = 50);

HTML Title displayed for this page.

Property methods: TitleDisplayToLogical(), TitleGet(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()

Methods

method MakeFramePopupLink(pURL As %String, ByRef pID As %String = "", ByRef pVARS As %String = "") as %String

Construct a link for a frame popup window

method MakeLink(pURL As %String, ByRef pID As %String = "", ByRef pVARS As %String = "") as %String

Construct a link to another AutoPage If pTargetFrame, this is a link for a specific frame

method MakePopupLink(pURL As %String, ByRef pID As %String = "", ByRef pVARS As %String = "") as %String

Construct a link to a popup window

method MakeRedirectLink(pURL As %String, pSubmitBtn As %String = "") as %String

Construct a link for redirecting to an AutoPage with its page-related query. This is used when you need to redirect a page (after a submit, for example).