%ZEN.Submit
deprecated class %ZEN.Submit extends %Library.RegisteredObject
This object is used to hold values and details of a Submit operation.Property Inventory
Method Inventory
Properties
property %Action as %String;
Name of submit action. This comes from the action
property of the %ZEN.Component.submit that
submitted this form.
Property methods: %ActionDisplayToLogical(), %ActionGet(), %ActionIsValid(), %ActionLogicalToDisplay(), %ActionLogicalToOdbc(), %ActionNormalize(), %ActionSet()
property %Data as %String [ MultiDimensional ];
Internal property.
Array of submitted values, indexed by control name.
Array of submitted values, indexed by control name.
Property methods: %DataDisplayToLogical(), %DataGet(), %DataIsValid(), %DataLogicalToDisplay(), %DataLogicalToOdbc(), %DataNormalize(), %DataSet()
property %Errors as %String [ MultiDimensional ];
Internal property.
Array of errors in submitted values, indexed by control name.
Array of errors in submitted values, indexed by control name.
Property methods: %ErrorsDisplayToLogical(), %ErrorsGet(), %ErrorsIsValid(), %ErrorsLogicalToDisplay(), %ErrorsLogicalToOdbc(), %ErrorsNormalize(), %ErrorsSet()
property %FormId as %String;
Component id of the submitted form (if defined).
Property methods: %FormIdDisplayToLogical(), %FormIdGet(), %FormIdIsValid(), %FormIdLogicalToDisplay(), %FormIdLogicalToOdbc(), %FormIdNormalize(), %FormIdSet()
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.
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.
Property methods: %FormKeyDisplayToLogical(), %FormKeyGet(), %FormKeyIsValid(), %FormKeyLogicalToDisplay(), %FormKeyLogicalToOdbc(), %FormKeyNormalize(), %FormKeySet()
property %ModelClass as %String;
If the form is bound to a DataModel class, this is the name of the DataModel class.
Property methods: %ModelClassDisplayToLogical(), %ModelClassGet(), %ModelClassIsValid(), %ModelClassLogicalToDisplay(), %ModelClassLogicalToOdbc(), %ModelClassNormalize(), %ModelClassSet()
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.
This is initially set to the submitting form's nextPage property but can be modified by an %OnSubmit() method.
Property methods: %NextPageDisplayToLogical(), %NextPageGet(), %NextPageIsValid(), %NextPageLogicalToDisplay(), %NextPageLogicalToOdbc(), %NextPageNormalize(), %NextPageSet()
property %SkipProcessing as %Boolean [ InitialExpression = 0 ];
Internal Property.
If true, bypass the rest of the submit processing for this page.
If true, bypass the rest of the submit processing for this page.
Property methods: %SkipProcessingDisplayToLogical(), %SkipProcessingGet(), %SkipProcessingIsValid(), %SkipProcessingLogicalToDisplay(), %SkipProcessingNormalize(), %SkipProcessingSet()
Methods
method %GetStream(pCompName As %String)
Get a pointer to a MIME stream associated with a control by name
method %GetValue(pCompName As %String)
Get value associated with a control by name.
method %HasErrors() as %Boolean
Return true if errors have been added to this submit object.
Associate an error message with a component by name.
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.
This value will be applied to the control if the form is redisplayed because of errors.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()