Check Box Form Element

The Check Box form element displays a single checkbox that the user can select or clear.

Example of the Check Box form element, shown in a Geocortex viewer

See also...

Check Group Form Element

Check Box Properties

The following table describes the properties of the Check Box 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 Check Box Form Element

Checked

Type: Boolean

Name in Properties Panel: Checked

Name to Use in Expressions: checked

Indicates whether the checkbox is selected. If you want the checkbox to be cleared initially, clear the Checked checkbox.

To access the checked property in an expression:

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

For example:

$form1.state.checkBox1.checked

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, including the user's input. 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.checkBox1.visible

Enabled

Type: Boolean

Name in Properties Panel: Enabled

Name to Use in Expressions: enabled

Indicates whether the checkbox is enabled in the running workflow. When a checkbox is enabled, the user can select or clear the checkbox. When a checkbox is disabled, the user can see the checkbox but cannot interact with it. Disabled elements appear dimmed or shaded in the running workflow.

By default, checkboxes are enabled. To disable a checkbox initially, clear the Enabled checkbox. You may want to change the property's value at run time depending on the user's input in a previous form element.

To access the enabled property in an expression:

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

For example:

$form1.state.checkBox1.enabled

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.

Label

Type: String

Name in Properties Panel: Label

Name to Use in Expressions: label

The text that appears beside the checkbox.

To access the label property in an expression:

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

For example:

$form1.state.checkBox1.label

Title

Type: String

The element's title, which appears at the top of the element. By default, the title is blank.

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.

Tooltip

Type: String

A message that displays when the user hovers the mouse pointer over the checkbox. You may want to use the tooltip to provide help to the user.

type

Type: String

The variety of form element. Checkboxes are type "CheckBox".

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.checkBox1.type

value

Type: any

An arbitrary value that you want to associate with the checkbox.

To access the value property in an expression:

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

For example:

$form1.state.checkBox1.value

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, checkboxes are visible. If you want to hide the element initially, clear the Visible checkbox. You may want to change the visibility at run time depending on the user's input in a previous form element.

To access the visible property in an expression:

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

For example:

$form1.state.checkBox1.visible

Check Box Events

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

Events for the Check Box 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. For example, you could set the checkbox's initial value.

change

The change event fires when the user selects or clears the checkbox.

You can use the change event to create dependencies between form elements. For example, you could configure a change subworkflow that enables or disables other form elements depending on the user's selection.

The change event fires every time the user's selection changes. This means that the checkbox's change subworkflow can run multiple times. Because of this, you should make sure that the change subworkflow is not computationally intensive or long running.

© 2018 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 5.9