Skip to main content


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

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.

Describes a particular pane within an AutoPage. This is an abstract class; its subclasses perform the real work.

Property Inventory

Method Inventory


parameter DOMAIN = %Utility;
Default Localization Domain
parameter XMLNAME = Pane;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property Align as %String (MAXLEN = 10, VALUELIST = ",left,right,center");
Suggestion for how to align this pane; Actual implementation is up to the subclass doing the rendering
Property methods: AlignDisplayToLogical(), AlignGet(), AlignIsValid(), AlignLogicalToDisplay(), AlignLogicalToOdbc(), AlignNormalize(), AlignSet()
property CommandFormClass as %String (MAXLEN = 128);
Name of class used to provide an option CommandForm: a form containing command buttons.
Note: there is no support for dynamic command forms.
Property methods: CommandFormClassDisplayToLogical(), CommandFormClassGet(), CommandFormClassIsValid(), CommandFormClassLogicalToDisplay(), CommandFormClassLogicalToOdbc(), CommandFormClassNormalize(), CommandFormClassSet()
property CommandFormObject as %RegisteredObject (XMLPROJECTION = "none");
Used to hold the object instance for the command form.
Property methods: CommandFormObjectGet(), CommandFormObjectGetSwizzled(), CommandFormObjectIsValid(), CommandFormObjectNewObject(), CommandFormObjectSet()
property CommandSubmitPage as %String (MAXLEN = 128);
Page (URL) to go to when the command form is submitted.
Property methods: CommandSubmitPageDisplayToLogical(), CommandSubmitPageGet(), CommandSubmitPageIsValid(), CommandSubmitPageLogicalToDisplay(), CommandSubmitPageLogicalToOdbc(), CommandSubmitPageNormalize(), CommandSubmitPageSet()
property Commands as list of Action;
A list of commands; these are actions that are typically displayed along the top of the pane.
Property methods: CommandsBuildValueArray(), CommandsCollectionToDisplay(), CommandsCollectionToOdbc(), CommandsDisplayToCollection(), CommandsGet(), CommandsGetObject(), CommandsGetObjectId(), CommandsGetSwizzled(), CommandsIsValid(), CommandsOdbcToCollection(), CommandsSet(), CommandsSetObject(), CommandsSetObjectId()
property FrameStyle as %String (MAXLEN = 50, XMLNAME = "FrameStyle");
Optional Style Sheet for a pane; Set to "none" to supress style-sheet for a fram
Property methods: FrameStyleDisplayToLogical(), FrameStyleGet(), FrameStyleIsValid(), FrameStyleLogicalToDisplay(), FrameStyleLogicalToOdbc(), FrameStyleNormalize(), FrameStyleSet()
property Name as %String (MAXLEN = 100, XMLPROJECTION = "none");
Transient: name of the pane/frame this pane is being used for
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Styles as array of %String (XMLKEYNAME = "name", XMLNAME = "PaneStyle", XMLPROJECTION = "ELEMENT");
Arbitrary array of styles (name/value pairs). All panes include this property.
Property methods: StylesBuildValueArray(), StylesCollectionToDisplay(), StylesCollectionToOdbc(), StylesDisplayToCollection(), StylesDisplayToLogical(), StylesGet(), StylesGetObject(), StylesGetObjectId(), StylesGetSwizzled(), StylesIsValid(), StylesLogicalToDisplay(), StylesLogicalToOdbc(), StylesNormalize(), StylesOdbcToCollection(), StylesSet(), StylesSetObject(), StylesSetObjectId()
property Text as %String (MAXLEN = 500);
Test for this pane. All panes include this property.
Property methods: TextDisplayToLogical(), TextGet(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize(), TextSet()
property URL as %String (MAXLEN = 256, XMLNAME = "url", XMLPROJECTION = "element");
Optional URL to display instead of this pane (for frame-pages)
Property methods: URLDisplayToLogical(), URLGet(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()


method DrawBODY(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the BODY section.
method DrawCommandForm(pInstance As PageInstance) as %Status
Generic method to draw a command form for a pane
method DrawCommands(pInstance As PageInstance) as %Status
Generic method to draw commands for a pane; A subclass can override this.
method DrawHEAD(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
method GenerateCode() as %String
Called by CSP rules engine to generate code to construct an instance of this object using the current instance as a template.
classmethod LocalizeText(pText As %String, pDomain As %String = "%Utility") as %String
Return the localized version of the string pText. A localizable string starts with "@[domainname:]textid@....." If domainname exists then use it ; Else if pDomain passed in then use it ; Else default to %Utility. Also, substitute any run-time expressions of the form {$ID1} with Page variables...
method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
classmethod QuoteCOS(pText As %String) as %String
Return a quoted, COS version of a string.

Inherited Members

Inherited Methods


FeedbackOpens in a new tab