This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %CSP.Util.PageInstance


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

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

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 (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

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 (Including Private)

private method %OnNew(initval As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Construct a link for a frame popup window
Construct a link to another AutoPage If pTargetFrame, this is a link for a specific frame
Construct a link to a popup window
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).

Inherited Members

Inherited Methods (Including Private)