Header Form Element

All forms have a Header element that contains the form's title and an icon to close the form. When you create a new form, the header element is added automatically to the top of the form. You can change the header's text to give your form a meaningful name, but you cannot move or delete the header.

Example of the Header form element, shown in a Geocortex viewer

Header Properties

The following table describes the properties of the Header form element. Some properties can be configured in the Properties panel in Workflow Designer. These properties have configuration information in the table. Similarly, some properties can be accessed in expressions. These properties have information about how to access the property in an expression.

If a property can be configured in the Properties panel and accessed in expressions, the property has two names: the name that appears in the Properties panel and the name that is used in expressions. Both names are given in the table. Sometimes the names only differ in capitalization, for example, Visible (in the Properties panel) or visible (in expressions).

Properties of the Header Form Element

Element ID

Type: String

The element's ID, which is used in other form elements and activities to access the element's properties. The ID must be unique across all elements in the form.

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.Header.visible

error

Type: String | MarkdownRef

Indicates whether an error occurred in the element.

MarkdownRef objects have a markdown property of type String that represents the Markdown text.

We recommend using the Set Form Element Error and Clear Form Element Error activities to work with errors in form elements.

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. Descriptive titles make forms easier to understand.

You can format the title using Markdown.

type

Type: String

The variety of form element. Headers are type "Header".

Use the type property to find out the variety of a form element in a form with many elements: loop through ${Display Form ID}.state, comparing each element to the known form types and performing some action on the elements that meet your type criteria.

To access the type property in an expression:

${Display Form ID}.state.{Element ID}.type

For example:

$form1.state.Header.type

Header Events

The following table describes the events associated with the Header form element. As in Workflow Designer, the events are listed in the order that they fire.

Events for the Header Form Element

load

The load event fires when the element finishes loading.

You can use the load event to set one or more of the element's properties at run time.

Documentation Version 5.12