Skip to main content
Skip table of contents

Checkbox

Element

Icon

Description

Field used to activate or deactivate one single option.

Type

Boolean

Prepopulation

This element can be prepopulated.

  • You can set a default value in the Attributes panel to be applied before displaying the form. Refer to Changing BPMN Element Attributes for more information.

  • You can overwrite these defaults dynamically in the Get Data execution of a user task. How to do this is explained on Using Forms.

Editing

Refer to Modeling Forms for further information regarding editing of form elements using the context menu.

Configuration Options

Use the Attributes panel to edit the form element.

Attribute

Description

Allowed Values

Name

Technical identifier for data processing and not visible for the end user.

Alphanumercial characters and underscore.

It is not allowed to start the name with a number.

Description

A commentary field for the developer. The content is invisible to users and its sole purpose is internal documentation.

Any string.

Label

Field name shown in the form.

Any string.

Mandatory

The element must be filled or used if the checkbox is activated.

true

Element must be filled.

false

Element may remain empty (default).

Read-only

This field is write-protected. When you use the option, Read-only is added to the bottom right of the element:

readOnly_inputField.png

true

User cannot enter values.

false

User can enter values (default).

Checked

Use attribute Checked to preset a checkbox. If the attribute is enabled, the checkbox in the element is already checked during form execution. The value of the element will be saved to the database during form execution.

true

The element is active.

false

The element is deactivated (default).

Label Position

Use this option to change the position of the checkbox and its label.

Before checkbox

The text is placed before the checkbox.

After checkbox

The text is placed after the checkbox (default).

Vertical Alignment

The attribute is used to adjust the position of a form element in context to a bigger neighboring element.

Example: The Radio Button Group Color is much bigger than the Button Next, but the button should be shown at the bottom of the form. Therefore, the button's attribute Vertical Alignment is set to Bottom.

example_form_alignment.png

Top

Align the element on top of the element cell (default).

Center

Align the element in the middle of the element cell.

Bottom

Align the element at the bottom of the element cell.

CSS Class

Enables a field-acurate layout customization.

A valid CSS class.

Custom Attributes

The attribute is used to activate Angular directives, that are created as development kit (devkit) library to expand the default functionality.

For detailed information about Angular directives, visit the official Angular documentation. For details about the usage of the Custom Attributes, refer to Developing Custom Directives.

  • empty attribute

  • attribute with value (e.g. color="red")

  • multiple entries separated by space (e.g. color="red" multiline max="5")

Symbol Type

Displays the type of the form element in read-only mode.

_

Simple_Form_Example

Click here to download a simple example model that shows how you can configure form elements in Scheer PAS Designer.

Form_InitialDataLoading_Checkbox_Example

Click here to download a simple example model that shows how you can initialize checkbox elements dynamically in a form.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.