Class %CSP.Util.FormButton

serial class %CSP.Util.FormButton extends %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 a submit button for an AutoForm form.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	6	1

Summary

Properties
Caption	Confirm	HREF	Name	OnClick
Type

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

Parameters

• parameter XMLNAME = "Button";

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.

Properties

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

Caption used for a form submit button (value attribute for the button)

• property Confirm as %String(MAXLEN=100,XMLNAME="confirm",XMLPROJECTION="attribute");

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

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

URL associated with this button (currently used for popup);

• property Name as %String(MAXLEN=30,XMLNAME="name",XMLPROJECTION="attribute");

Name used for a form submit button: e.g., $AUTOFORM_SAVE

• property OnClick as %String(MAXLEN=255,XMLNAME="onclick",XMLPROJECTION="attribute");

If defined, onclick behavior (JavaScript) for this button

• property Type as %String(VALUELIST=",popup",XMLNAME="type",XMLPROJECTION="attribute");

What type of action does this button do: submit (default), popup (show a popup).

Methods

• method GenerateCode() as %String

Utility method to generate code for this object

Class Reference IRIS for UNIX 2024.1.2
Documentation Search