Skip to main content


serial class %CSP.Util.Action extends %Library.SerialObject, %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.

Defines an action for a CSP Utility page.

Property Inventory

Method Inventory


property Caption as %String (MAXLEN = 100);
When used as a menu, this is the menu caption.
This is a localizable value.
Property methods: CaptionDisplayToLogical(), CaptionGet(), CaptionIsValid(), CaptionLogicalToDisplay(), CaptionLogicalToOdbc(), CaptionNormalize(), CaptionSet()
property Condition as %String (MAXLEN = 255, XMLNAME = "condition", XMLPROJECTION = "attribute");
(Optional) A COS expression that must evaluate true in order to use this link
Property methods: ConditionDisplayToLogical(), ConditionGet(), ConditionIsValid(), ConditionLogicalToDisplay(), ConditionLogicalToOdbc(), ConditionNormalize(), ConditionSet()
property Confirm as %String (MAXLEN = 500);
If present, then display this as a confirmation message for the action.
Property methods: ConfirmDisplayToLogical(), ConfirmGet(), ConfirmIsValid(), ConfirmLogicalToDisplay(), ConfirmLogicalToOdbc(), ConfirmNormalize(), ConfirmSet()
property Encrypted as %Boolean (XMLNAME = "encrypted", XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true the values will be encrypted before they are added to the link
Property methods: EncryptedDisplayToLogical(), EncryptedGet(), EncryptedIsValid(), EncryptedLogicalToDisplay(), EncryptedLogicalToXSD(), EncryptedNormalize(), EncryptedSet(), EncryptedXSDToLogical()
property HREF as %String (MAXLEN = 128, XMLNAME = "href", XMLPROJECTION = "attribute");
Name of page to go to.
Property methods: HREFDisplayToLogical(), HREFGet(), HREFIsValid(), HREFLogicalToDisplay(), HREFLogicalToOdbc(), HREFNormalize(), HREFSet()
property IDExprList as %String (MAXLEN = 500, XMLNAME = "IDValues");
A comma-separated list of all the IDValues in one list; this is used only by XML import/export.
Property methods: IDExprListDisplayToLogical(), IDExprListIsValid(), IDExprListLogicalToDisplay(), IDExprListLogicalToOdbc(), IDExprListNormalize()
property IDValues as %String [ MultiDimensional ];
An array (subscripted by contiguous integer values) of ID values for this action. These values are used to specify a specific instance of page to display.
This value is either a literal or the name of column in the current query enclosed within { } (e.g., {Name} ).
Property methods: IDValuesDisplayToLogical(), IDValuesGet(), IDValuesIsValid(), IDValuesLogicalToDisplay(), IDValuesLogicalToOdbc(), IDValuesNormalize(), IDValuesSet()
When appropriate, popup help for this action.
This is a localizable value.
Property methods: PopupDisplayToLogical(), PopupGet(), PopupIsValid(), PopupLogicalToDisplay(), PopupLogicalToOdbc(), PopupNormalize(), PopupSet()
property TargetFrame as %String (MAXLEN = 50, XMLNAME = "targetFrame", XMLPROJECTION = "attribute");
If set, the name of the frame affected by the action
Property methods: TargetFrameDisplayToLogical(), TargetFrameGet(), TargetFrameIsValid(), TargetFrameLogicalToDisplay(), TargetFrameLogicalToOdbc(), TargetFrameNormalize(), TargetFrameSet()
property Type as %String (VALUELIST = ",link,popup,help", XMLNAME = "type", XMLPROJECTION = "attribute");
What type of Action is this:
link: link to another page (default).
popup: launch a popup window.
help: launch a documentation window. ID1 will be DocBook ID.
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


method GenerateCode() as %String
Utility method to generate code for this object
method GetIDValues(ByRef ids As %String)
Evaluate the current value of the IDValues associated with this Action. IDValues are either literals, or expressions referring to page properties: {$ID1}
method IDExprListGet() as %String
method IDExprListSet(val As %String) as %Status

Inherited Members

Inherited Methods

FeedbackOpens in a new tab