Class %CSP.Util.Action

serial class %CSP.Util.Action extends %SerialObject, %XML.Adaptor

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.

Defines an action for a CSP Utility page.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	9	4

Summary

Properties
Caption	Condition	Confirm	HREF	IDExprList
IDValues	Popup	TargetFrame	Type

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%ClassIsLatestVersion
%ClassName	%ConstructClone	%Delete	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%GetSwizzleObject	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OnBeforeAddToSync
%OnDetermineClass	%Open	%OpenId	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%SerializeObject
%SetModified	%SyncObjectIn	%SyncTransport	%ValidateObject
GenerateCode	GetIDValues	IDExprListGet	IDExprListSet
LogicalToOdbc	OdbcToLogical	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType

Properties

• property Caption as %String(MAXLEN=100);

When used as a menu, this is the menu caption.
This is a localizable value.

• 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 Confirm as %String(MAXLEN=500);

If present, then display this as a confirmation message for the action.

• property HREF as %String(MAXLEN=128,XMLNAME="href",XMLPROJECTION="attribute");

Name of page to go to.

• 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 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 Popup as %String(MAXLEN=100);

When appropriate, popup help for this action.
This is a localizable value.

• property TargetFrame as %String(MAXLEN=50,XMLNAME="targetFrame",XMLPROJECTION="attribute");

If set, the name of the frame affected by the action

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

Methods

• 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

This is a Get accessor method for the IDExprList property.

• method IDExprListSet(val As %String) as %Status

This is a Set accessor method for the IDExprList property.


[BASEXML] > [%CSP] > [Util] > [Action]		Private Storage