Skip to main content

%ZEN.Submit

Class %ZEN.Submit Extends %RegisteredObject [ Deprecated, System = 3 ]

This object is used to hold values and details of a Submit operation.

Properties​

%Data​

Property %Data As %String [ MultiDimensional ];

Internal property.
Array of submitted values, indexed by control name.

%Errors​

Property %Errors As %String [ MultiDimensional ];

Internal property.
Array of errors in submitted values, indexed by control name.

%Action​

Property %Action As %String;

Name of submit action. This comes from the action property of the %ZEN.Component.submit that submitted this form.

%FormId​

Property %FormId As %String;

Component id of the submitted form (if defined).

%FormKey​

Property %FormKey As %String;

Key value (object id) associated with the submitted form (if any).
If the form defines an OnLoadForm callback, this contains the user-supplied key value used to load data for the form.
If the form is bound to a DataModel, this contains the id of the DataModel object.

%ModelClass​

Property %ModelClass As %String;

If the form is bound to a DataModel class, this is the name of the DataModel class.

%NextPage​

Property %NextPage As %String;

Page to redirect to after a submit.
This is initially set to the submitting form's nextPage property but can be modified by an %OnSubmit method.

%SkipProcessing​

Property %SkipProcessing As %Boolean [ InitialExpression = 0 ];

Internal Property.
If true, bypass the rest of the submit processing for this page.

Methods​

%HasErrors​

Method %HasErrors() As %Boolean [ CodeMode = expression ]

Return true if errors have been added to this submit object.

%SetError​

Method %SetError(pCompName As %String, pError As %String)

Associate an error message with a component by name.

%GetValue​

Method %GetValue(pCompName As %String) [ CodeMode = expression ]

Get value associated with a control by name.

%GetStream​

Method %GetStream(pCompName As %String) [ CodeMode = expression ]

Get a pointer to a MIME stream associated with a control by name

%SetValue​

Method %SetValue(pCompName As %String, pValue As %String = "")

Set the value associated with a control by name.
This value will be applied to the control if the form is redisplayed because of errors.