This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %CSP.Util.FormPane


class %CSP.Util.FormPane extends %CSP.Util.Pane

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.

A pane that contains an AutoForm object.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Buttons as list of FormButton (XMLITEMNAME = "Button");
An optional list of buttons displayed along the bottom of a form.
Property methods: ButtonsBuildValueArray(), ButtonsCollectionToDisplay(), ButtonsCollectionToOdbc(), ButtonsDisplayToCollection(), ButtonsGet(), ButtonsGetObject(), ButtonsGetObjectId(), ButtonsGetSwizzled(), ButtonsIsValid(), ButtonsOdbcToCollection(), ButtonsSet(), ButtonsSetObject(), ButtonsSetObjectId()
property Display as %String (MAXLEN = 20, VALUELIST = ",form,table");
How to display this Form Page.
Property methods: DisplayDisplayToLogical(), DisplayGet(), DisplayIsValid(), DisplayLogicalToDisplay(), DisplayLogicalToOdbc(), DisplayNormalize(), DisplaySet()
property Dynamic as %Boolean;
If true, display this form using the Dynamic form viewer.
Property methods: DynamicDisplayToLogical(), DynamicGet(), DynamicIsValid(), DynamicLogicalToDisplay(), DynamicLogicalToXSD(), DynamicNormalize(), DynamicSet(), DynamicXSDToLogical()
property FormClass as %String (MAXLEN = 128);
Name of class used to provide Detail or Form view;
Property methods: FormClassDisplayToLogical(), FormClassGet(), FormClassIsValid(), FormClassLogicalToDisplay(), FormClassLogicalToOdbc(), FormClassNormalize(), FormClassSet()
property FormObject as %RegisteredObject (XMLPROJECTION = "none");
The object that provides the details to display.
Property methods: FormObjectGet(), FormObjectGetSwizzled(), FormObjectIsValid(), FormObjectNewObject(), FormObjectSet()
property SubmitPage as %String (MAXLEN = 128);
Page (URL) to go to when a form is submitted.
Property methods: SubmitPageDisplayToLogical(), SubmitPageGet(), SubmitPageIsValid(), SubmitPageLogicalToDisplay(), SubmitPageLogicalToOdbc(), SubmitPageNormalize(), SubmitPageSet()
property SubmitTarget as %String (MAXLEN = 128);
TARGET attribute for submitted form.
Property methods: SubmitTargetDisplayToLogical(), SubmitTargetGet(), SubmitTargetIsValid(), SubmitTargetLogicalToDisplay(), SubmitTargetLogicalToOdbc(), SubmitTargetNormalize(), SubmitTargetSet()

Methods (Including Private)

method DrawBODY(pInstance As PageInstance) as %Status
Draw the BODY of the detail pane
method OnGenerateCode() as %String
Inherited description: Subclasses override this to generate code during CSP processing

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window