This class is used internally by InterSystems IRIS. More...

Inheritance diagram for PageInstance:

[legend]

Collaboration diagram for PageInstance:

[legend]

Public Member Functions
_.Library.String	MakeFramePopupLink (_.Library.String pURL, _.Library.String pID, _.Library.String pVARS)
	Construct a link for a frame popup window.

_.Library.String	MakeLink (_.Library.String pURL, _.Library.String pID, _.Library.String pVARS)
	Construct a link to another AutoPage. More...

_.Library.String	MakePopupLink (_.Library.String pURL, _.Library.String pID, _.Library.String pVARS)
	Construct a link to a popup window.

_.Library.String	MakeRedirectLink (_.Library.String pURL, _.Library.String pSubmitBtn)
	Construct a link for redirecting to an AutoPage with its page-related query. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

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

	IDValues
	An array (integer-subscripted) of values use to identify. More...

	PageClass
	Name of CSP class hosting this page. More...

	PageVars
	An array of page-directed variables, subscripted by. More...

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

	Title
	HTML Title displayed for this page. More...

Additional Inherited Members
Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

This class is used internally by InterSystems IRIS.

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.

Member Function Documentation

◆ MakeLink()

_.Library.String MakeLink	(	_.Library.String	pURL,
		_.Library.String	pID,
		_.Library.String	pVARS
	)

Construct a link to another AutoPage.

If pTargetFrame, this is a link for a specific frame

◆ MakeRedirectLink()

_.Library.String MakeRedirectLink	(	_.Library.String	pURL,
		_.Library.String	pSubmitBtn
	)

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).

Member Data Documentation

◆ Address

Address

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

◆ IDValues

IDValues

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.

◆ PageClass

PageClass

Name of CSP class hosting this page.

◆ PageVars

PageVars

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.

◆ Panes

Panes

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

◆ Title

Title

HTML Title displayed for this page.

Public Member Functions

Public Attributes

Additional Inherited Members