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

AVEVA™ Work Tasks

Text

  • Last UpdatedJun 25, 2024
  • 5 minute read

Use Text control to enter and view textual data 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.

Default Value

The default value for the control.

Note: Ensure the value is within the Minimum Length and the Maximum Length.

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.

Read-Only

Allow or deny a user to enter a value for the control.

  • Select Yes to deny a user to enter a value for the control.

  • Select No to allow a user to enter a value for the control.

    The default value is No.

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.

Watermark

Hint text that appears when no value is entered for the control.

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.

Display Mode

Number of lines to show for the control.

  • Select Single Line to allow a user to enter one line of text for the control.

  • Select Multi Line to allow a user to enter multiple lines of text for the control.

    The default value is Single Line.

Note: The Multi Line option is applicable only when the Rows property is set to 2 or more.

Rows

Number of rows for the control.

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.

Text Pattern

Regular expression to validate the text for the control.

For example, use the following regular expression to validate a text string as  a phone number:

^[2-9]\d{2}-\d{3}-\d{4}$

Minimum Length

Minimum length of the value for the control.

The default value is 0.

Note: If the value is 0, then the minimum length for the control is not set.

Maximum Length

Maximum length of the value for the control.

The default value is 0.

Note: If the value is 0, then the maximum length for the control is not set.

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.

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 Text control.

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