Skip to main content


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

Property Inventory

Method Inventory


parameter XMLNAME = Button;
Inherited description: 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.


property Caption as %String (MAXLEN = 50, XMLNAME = "caption", XMLPROJECTION = "attribute");
Caption used for a form submit button (value attribute for the button)
Property methods: CaptionDisplayToLogical(), CaptionGet(), CaptionIsValid(), CaptionLogicalToDisplay(), CaptionLogicalToOdbc(), CaptionNormalize(), CaptionSet()
property Confirm as %String (MAXLEN = 100, XMLNAME = "confirm", XMLPROJECTION = "attribute");
If present, then display this as a confirmation message for the button.
Property methods: ConfirmDisplayToLogical(), ConfirmGet(), ConfirmIsValid(), ConfirmLogicalToDisplay(), ConfirmLogicalToOdbc(), ConfirmNormalize(), ConfirmSet()
property HREF as %String (MAXLEN = 128, XMLNAME = "href", XMLPROJECTION = "attribute");
URL associated with this button (currently used for popup);
Property methods: HREFDisplayToLogical(), HREFGet(), HREFIsValid(), HREFLogicalToDisplay(), HREFLogicalToOdbc(), HREFNormalize(), HREFSet()
property Name as %String (MAXLEN = 30, XMLNAME = "name", XMLPROJECTION = "attribute");
Name used for a form submit button: e.g., $AUTOFORM_SAVE
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property OnClick as %String (MAXLEN = 255, XMLNAME = "onclick", XMLPROJECTION = "attribute");
If defined, onclick behavior (JavaScript) for this button
Property methods: OnClickDisplayToLogical(), OnClickGet(), OnClickIsValid(), OnClickLogicalToDisplay(), OnClickLogicalToOdbc(), OnClickNormalize(), OnClickSet()
property Type as %String (VALUELIST = ",popup", XMLNAME = "type", XMLPROJECTION = "attribute");
What type of action does this button do: submit (default), popup (show a popup).
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


method GenerateCode() as %String
Utility method to generate code for this object

Inherited Members

Inherited Methods

FeedbackOpens in a new tab