Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

Check Box

  • Last UpdatedJun 25, 2024
  • 5 minute read

Use Check Box control to turn on or turn off an option by selecting or clearing the check box in your form.

Properties

The properties for the control are grouped under the following tabs:

Basic

Property

Description

Name

Name that identifies the control. This value is also used for the label of the control.

XML Node

XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.

  • Prefix with @ to use the value of the control as an attribute with the immediate parent node. For example, @FirstName.

  • Use / for a parent-child node configuration to uniquely identify a control in a form with multiple containers. For example, Employee/FirstName.

    The default value is the value for the Name property without the spaces.

Note:
- If you use / to denote a parent which is not a container and the parent is at the same level as that of the child, then the XML node for the control is not generated.
- If you edit this value later, then it might affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Tooltip

Message that appears when the pointer hovers over the control.

Options

Options for the control.

To add an option to the control

  1. Click Add Record. A new record appears.

  2. In the Text box, enter the options text.

  3. In the Value box, enter the options value.

  4. In the Fore Color palette, click a color (or in the Color Code box, enter hexadecimal code of the color), and then click Apply. The selected color is applied to the foreground of the options text.

  5. In the Back Color palette, click a color (or in the Color Code box, enter hexadecimal code of the color), and then click Apply. The selected color is applied to the background of the options text.

To clear fore color for an option of the control

  • On the Fore Color palette, in the Color Code box, enter #1b1b1b, and then click Apply. The Fore Color is reset to the default color.

To clear back color for an option of the control

  • On the Back Color palette, in the Color Code box, enter #1b1b1b, and then click Apply. The Back Color is reset to the default color.

To delete an option from the control

  • Click the Delete button. The record is deleted.

Note: The options Text and Value parameters are mandatory and must be unique across all options.

Default Value

The default value for the control.

Note:
- The value must be one of the values set for the Value parameter in the Options property.
-Multiple values must be separated with ;#

Appearance

Property

Description

Enable

Enable or disable the control.

  • Select Yes to enable the control.

  • Select No to disable the control.

    The default value is Yes.

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

Label Position

Position of the label for the control.

  • Select Default to allow the system to align the label. The system aligns the label to the left of the control or as specified by the container control.

  • Select Left to align the label to the left of the control.

  • Select Top to align the label to the top of the control.

  • Select Right to align the label to the right of the control.

  • Select Bottom to align the label to the bottom of the control.

  • Select Suppress to hide the label for the control.

    The default value is Default.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control.
- For example, if the value is Default and the control is placed on a Base Form with Label Position property set to Top, then the label is aligned to the top of the control.

Label-Control Area

Area occupied by the label and the control in percentage.

  • Select Default to allow the system to set the label and the control areas.

  • Select Custom to specify the label area. The control area is automatically set based on the label area.

    The default value is Default.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control.
- This is applicable only when the Label Position is set to Left or Right.

Width

Width in pixels for the control.

The default value is 0.

Note: If the value is 0, then the width of the control is set as per the default values.

Height

Height in pixels for the control.

The default value is 0.

Note: If the value is 0, then the height of the control is set as per the default values.

Retain Space

Reserve or remove space when the control is hidden.

  • Select Yes to keep space when the control is hidden.

  • Select No to remove space when the control is hidden.

    The default value is No.

Options Per Row

Number of options per row for the control.

Enter a value from 0 to 10.

Options Direction

Direction of the options for the control.

  • Select Horizontal to align the options next to each other for the control.

  • Select Vertical to align the options one  below the other for the control.

    The default value is Horizontal.

Validation

Property

Description

Mandatory

Enforce or bypass entering a value for the control.

  • Select Yes to enforce entering a value for the control.

  • Select No to bypass entering a value for the control.

    The default value is No.

Note: Validation message appears only on submission of the form.

Advanced

Property

Description

On Data Change

Run a script when value of the control changes.

For more information, see scripting guidelines for On Data Change property.

ID

Reference identification code for the control. This value is automatically generated and cannot be changed.

Text Parameter

Name that identifies the options text to use in scripts for the control.

Value Parameter

Name that identifies the options value to use in scripts for the control.

Forms 2011 Compatible

Make the control compatible with Forms 2011, that is the forms used in BPM 2011.

  • Select Yes to allow the system to make the control compatible with Forms 2011.

  • Select No to deny the system to make the control compatible with Forms 2011.

    The default value is No.

Note: When a control on a form is made Forms 2011 compatible, the XML instance of the form with the control is changed to ensure compatibility with Forms 2011.

Include in Summary

Allow or deny a user to view the value in the Summary of a Base Form.

  • Select Yes to allow a user to view the value in the Summary of a Base Form.

  • Select No to deny a user to view the value in the Summary of a Base Form.

    The default value is No.

Note:
- This property is applicable only when the control is used on a Base Form with Repeating property set to True, and the form is viewed on a small form factor mobile device.
- For information about Summary of a Base Form, see Base Form.

Scripts

For information about using scripts, see scripting guidelines for Check Box control.

Related Links
TitleResults for “How to create a CRG?”Also Available in