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 > ENSLIB namespace > CSPX.EnsPurgePane


class CSPX.EnsPurgePane extends %CSP.Util.Pane

Generic pane for individual type purge

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
Use our own domain for localization


property Buttons as list of %CSP.Util.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 PurgeType as %String;
Purge Type
Property methods: PurgeTypeDisplayToLogical(), PurgeTypeGet(), PurgeTypeIsValid(), PurgeTypeLogicalToDisplay(), PurgeTypeLogicalToOdbc(), PurgeTypeNormalize(), PurgeTypeSet()
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()


method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
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.
method OnGenerateCode() as %String
Inherited description: Subclasses override this to generate code during CSP processing

Inherited Members

Inherited Properties

Inherited Methods