Display Form Activity

Description

The Display Form activity is a powerful way to gather multiple inputs of various types from the user all in one step. This activity provides access to the Form Designer where you can create complex forms collecting multiple pieces of information that can be passed to subsequent activities.

Usage

You may need to collect a lot of user input. A convenient way to do this is with a Display Form activity. There are many types of data you can collect such as geometries, text, dates and many more. For a complete list see our form elements page.

Inputs

Reset

Optional

Type: Boolean

Indicates whether the form should be reset.

This is typically used when a workflow returns to a form that has already been presented to the end user.

Target

Optional

Type: "default" | "modal" | String

Indicates what container to use when displaying the form:

default: Displays the form wherever the workflow is running
modal: Displays the form in a modal window

In addition to default and modal, the Geocortex Viewer for HTML5 supports any container defined in the Workflow module's containers element, including Default (same as default), DefaultNoCloseButton, ModalWindow (same as modal), ModalWindowNoCloseButton, and any custom containers you have configured. For more information, see Workflow Containers in the Geocortex Viewer for HTML5 documentation.

Outputs

state

Type: Lookup<defs.Element>

The state of the form. Use this to update or access the values of form elements.

result

Type: String

The result of the form.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Supported Environments

Environments capable of running this activity

Server	Client
Server	Geocortex Web	Geocortex Mobile	Geocortex Viewer for HTML5	Web AppBuilder

Levels of Support: Full Support Partial Support No Support

Partially Supported Environments

Geocortex Web and Geocortex Mobile do not support the Target input. Instead, the form's location in the running workflow is determined by the workflow component's location in the app.

For example, to display a form in a panel, place the workflow's component in a Panel component. Similarly, to show a form in a modal window, place the workflow's component in a Dialog component.

Offline Support

This activity works when the device is offline.

Version Information

Supported from: Geocortex Viewer for HTML5 2.9, Web AppBuilder for ArcGIS 2.4.