The Text Box form element allows the user to enter one line of text.
Example of the Text Box form element with some text entered in it, shown in a Geocortex viewer
The Properties table describes the properties of the
Property names in Workflow Designer's Properties panel are written using the capitalization and spacing of a title. Property names in expressions are valid JavaScript identifiers and start with a lower case letter. Expressions are case sensitive. When you access a form element property in an expression, you must use the correct capitalization.
In the table below:
If a property can be accessed in both the Properties panel and expressions, then the table gives both versions of the name.
If a property's name in the table starts with a lower case letter, then you can only access the property in expressions.
If a property's name starts with a capital letter and the table does not give a name to use in expressions, then you can only access the property in the Properties panel.
Properties of the Text Box Form Element
Default Value |
Type: String
The text that appears initially in the
|
Description |
Type: String A description of the element. The description appears below the element's title. You can use the Description property to describe what the element represents or to provide instructions to the user about how to use the element. You can format the description using Markdown. |
Element ID |
Type: String The element's ID, which is used in other form elements and activities to access the element's properties You cannot get or set the value of the Element ID property in an expression—you can only use the value that you configured for it. To use the Element ID property in an expression: ${Display Form ID}.state.{Element ID}.{property name} For example: $form1.state.textBox1.visible |
Enabled |
Type: Boolean Name in Properties Panel: Enabled Name to Use in Expressions: enabled Indicates whether the By default, To access the ${Display Form ID}.state.{Element ID}.enabled For example: $form1.state. |
error |
Type: String | MarkdownRef Indicates whether an error occurred in the element. We recommend using the Set Form Element Error and Clear Form Element Error activities to work with errors in form elements. |
Maximum Length |
Type: Number Name to use in Expressions: maxLength The maximum number of characters that can be entered in a field. To access the ${Display Form ID}.state.{Element ID}.maxLength For example: $form1.state. |
Read Only |
Type: Boolean Name in Properties Panel: Read Only Name to Use in Expressions: readOnly Indicates whether the user can edit the text in the Use the Read Only property to prevent the user from changing the text in the By default, the user can change the text in a To access the ${Display Form ID}.state.{Element ID}.readOnly For example: $form1.state. |
Type: Boolean Name in Properties Panel: Required Name to Use in Expressions: require Indicates whether the user must By default, The Required checkbox is intended as a quick way to do simple validation without having to add a To access the ${Display Form ID}.state.{Element ID}.require For example: $form1.state. |
styleName |
Type: String
Indicates the name of the style that will be applied to the element. To access the ${Display Form ID}.state.{Element ID}.styleName For example: $form1.state. |
Title |
Type: String The element's title, which appears at the top of the element. You may want to change the title to describe what the element represents in your workflow. You can format the title using Markdown. |
Tooltip |
Type: String A message that displays when the user hovers the mouse pointer over the |
type |
Type: String The variety of form element. Use the To access the ${Display Form ID}.state.{Element ID}.type For example: $form1.state.textBox1.type |
value |
Type: String
The text that the user entered in the To access the ${Display Form ID}.state.{Element ID}.value For example: $form1.state. |
Visible |
Type: Boolean Name in Properties Panel: Visible Name to Use in Expressions: visible Indicates whether the element is visible to the user. By default, To access the ${Display Form ID}.state.{Element ID}.visible For example: $form1.state.textBox1.visible |
The following table describes the events associated with the
Events for the Text Box Form Element
load |
The You can use the |
change |
The You can use the The |
validate |
The You can use the If you use a Set Form Element Error activity, make sure you also use a Clear Form Element Error activity to clear the error. Otherwise the form may get stuck in an invalid state. By default, the Required property does not work when the For an example, see Example - Subworkflow for a Validate Event. |