Name | Description | Type | Additional information |
---|---|---|---|
id |
Dynamic Element Unique Identifier. |
string |
None. |
name |
Internal friendly identifier for this form element. |
string |
None. |
label |
Use this property to add text that displays as a label near the element. |
string |
None. |
formUUID | string |
None. |
|
help |
Help displayed as a tool tip or hint as to what this control requires. |
string |
None. |
required |
Use this property do specify if the element is a required field therefore, must have a value before submitting. |
boolean |
None. |
type |
Use this property on Input elements to specify which kind of input represents. The value must be the input type UUID. |
FormElementType |
None. |
order |
Use this property to specify the preferred order the element should use for rendering. This may be overwritten by the dynamic content representation of this element. |
integer |
None. |
prompt |
This is the watermark text shown to the user for elements like text fields, and text areas, and should not be considered a default value. |
string |
None. |
textType |
This optional property used by form elements of type text field, describes the kind of text field the app framework should represent. the default value is null, which is a synonym of 1 (Plain). Possible values are: 1 (Plain ) 2 (Phone Number) 3 (Zip Code) 4 (Email address) 5 (Numeric) 6 (Password) |
integer |
None. |
minLength |
This property sets the minimum amount of characters an input should have in order for the form to validate successfully, only if an element is not required, blank should be allowed for elements with "minimum other than zero" where minimum should be enforced only if the element has at least one value. For example: Required Field, Minimum = 6 - Value should be 6 characters minimum no exception. Not Required Field, Minim = 6 - Value can be empty, but if not empty, a minimum of 6 characters must be entered. |
integer |
None. |
maxLength |
This property limits the maximum amount of characters a text field should have. Zero means no limit. |
integer |
None. |
preFill |
Set to true, if the value from preFillTag should be added to the element as its content. |
boolean |
None. |
preFillTag |
Value used to prefill the control, (Special tags like [User Name] have been depreciated. |
string |
None. |
width |
Preferred Control Width. |
integer |
None. |
height |
Preferred Control Height. |
integer |
None. |
alignment |
Control Allignment |
string |
None. |
defaultOption |
Choice Unique identifier, this property is only used for choice or five element select control types. |
string |
None. |
minuteInterval |
Used for date time pickers to specify the amount of minutes to skip between minutes selector. |
integer |
None. |
defaultDate |
Default date to add to a date time picker. |
string |
None. |
minDate |
Minimum Date |
string |
None. |
maxDate |
Maximum Date |
string |
None. |
defaultCheck |
Default checked state value for a checkbox element type. |
boolean |
None. |
errorColor |
Color used to identify an error occurred during validation of this element upon form submit. |
string |
None. |
choices |
Used by form elements of type Choice, this collection contains a list of all choices exposed by this element. |
Collection of FormElementChoice |
None. |