Check Box Form Element

Type: String

Name in Properties Panel: Accessible Description

Name to Use in Expressions: accessibleDescription

An accessible version of the description of the element. The accesible description is not visible on the page; it is hidden.

You can use the Accessible Description property to provide a description that can be used by assistive technologies, such as screen readers.

Type: Boolean

Name in Properties Panel: Checked

Name to Use in Expressions: checked

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

To access the checked property in an expression:

For example:

Type: String

Name in Properties Panel: Description

Name to Use in Expressions: description

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.

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 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:

Type: Boolean

Name in Properties Panel: Enabled

Name to Use in Expressions: enabled

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

By default, Check Box elements are enabled. To disable a Check Box element, 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:

For example:

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.

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:

For example:

Type: String

Indicates the name of the style that will be applied to the element.

To access the styleName property in an expression:

For example:

Type: String

Name in Properties Panel: Title

Name to Use in Expressions: title

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.

You can format the title using Markdown.

Type: String

Name in Properties Panel: Title Location

Name to Use in Expressions: titleLocation

Specifies whether the element's title appears above (default) or beside the element.

The value must be either "above" or "beside".

Type: String

Name in Properties Panel: Tooltip

Name to Use in Expressions: tooltip

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

Type: String

The variety of form element. Check Box elements 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:

Type: any

An arbitrary value that you want to associate with the Check Box element.

To access the value property in an expression:

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

For example:

$form1.state.checkBox1.value

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 element's initial value.