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

AVEVA™ Work Tasks

Base Form

  • Last UpdatedJun 25, 2024
  • 7 minute read

Use Base Form control to manage controls placed on the record (child controls) in your form.

You can place any number of controls on a record, and add and delete records for the control. At run-time, you can click Add Record to repeat a record, and click Delete Record to remove a record. You can view the values of the child controls in the Summary of the Base Form only when the Repeating property for the child controls is set to True, and the form is viewed on a small form factor mobile device.

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.

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

Note: If you edit this value later, then it might affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Appearance

Property

Description

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

Note: If the value is No, then the child controls will be hidden even when the Visible property for the child controls is set to Yes.

Label Position

Position of the label for the child control.

  • Select Default to allow the system to align the label for the child control. The system aligns the label to the left of the child control.

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

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

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

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

  • Select Suppress to hide the label for the child control.

    The default value is Default.

Note:
- This property is applicable only if the Label Position property for the child control is set to Default.
- For example, if the Label Position property for the child control is set to Default and the Label Position property for the Base Form is set to Top, then the label for the child control is aligned to the top of the child control.
-The labels for all the controls are suppressed except - Data Grid, E-signature, Label, Embed Form, Embed Page, Tab, Panel, and Base Form.

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.

Display Mode

Show or hide the tabular view for the control.

  • Select Form to hide the tabular view for the control.

  • Select Grid to show the tabular view for the control.

    The default value is Grid.

Show Column Name

Show or hide the column name, when the Display Mode is set to Grid.

  • Select Yes to show the column name.

  • Select No to hide the column name.

    The default value is Yes.

Records Caption

Suffix for the add and delete links.

The default suffix is Record.

Note: The suffix is limited to 50 characters.

Record Position

Position of the records added at run-time for the control.

  • Select Top to position the records, added at run-time, at the top of the existing records for the control.

  • Select Bottom to position the records, added at run-time, at the bottom of the existing records for the control.

    The default value is Bottom.

Image Path

Path to the image for the control.

The image path is specified as:

  • xxx

Note:
- Base form image will be displayed when the screen is in Mobile View (< 800px)

Adapt UI

Change the user interface of the control based on the display width.

  • Select Yes to allow the system to change the user interface of the control based on the display width. The Web View is rendered for the control when the screen width is greater than or equal to 800 pixels. Otherwise, the Mobile View is rendered for the control.

  • Select No to deny the system to change the user interface of the control based on the display width. In this case, the Web View is rendered for the control.

    The default value is Yes.

Note: The responsiveness of the container depends on the value set for the Desktop View Only property at the Form level.

Validation

Property

Description

Show Confirmation Message

Show or hide the confirmation message for the control.

  • Select Yes to show the confirmation message for the control.

  • Select No to hide the confirmation message for the control.

    The default value is No.

Confirmation Message Text

Confirmation message for the control.

Note: This property is applicable only when the Show Confirmation Message property is set to Yes.

Repeating

Allow or deny a user to repeat records for the control.

  • Select True to allow a user to repeat records for the control.

  • Select False to deny a user to repeat records for the control.

  • Select Not Set to allow the system to set  the value for the control. The system allows a user to repeat records for the control.

    The default value is Not Set.

Minimum Records

Minimum records for the control.

The default value is 0.

Note: This property is applicable only when the Repeating property is set to True.

Maximum Records

Maximum records for the control.

Enter 0 for infinite records.

The default value is 0.

Note: This property is applicable only when the Repeating property is set to True.

Advanced

Property

Description

On Record Add

Run a script when a record is added.

For more information, see scripting guidelines for On Record Add property.

On Record Delete

Run a script when a record is deleted.

For more information, see scripting guidelines for On Record Delete property.

ID

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

Behavior

Manage records and edit values at run-time.

  • Select Editable to allow a user to add or delete records for the control, and to edit values of the child controls.

  • Select Read-Only to deny a user to add or delete records for the control, and deny to edit values of the child controls.

  • Select Allow Only Add to allow a user to add records for the control, but deny to edit values of the existing child controls. That is when the form is loaded, the existing records cannot be edited or deleted, but new records can be added, edited, and deleted till the form is submitted.

    The default value is Editable.

Default Number of Record

Number of records added at run-time for the control.

The default value is 1.

Fast Append

Add records in the Grid view at run-time by pressing the Tab key from the last focused control of the record.

  • Select Yes to allow adding records in the Grid view at run-time by pressing the Tab key from the last focused control of the record.

  • Select No to deny adding records in the Grid view at run-time by pressing the Tab key from the last focused control of the record.

    The default value is No.

Note:
This property is not applicable if:
- The Display Mode is set to Form or the Repeating property is set to False.
- The last focused control is a control on a child Base Form or a custom control.
- The form is viewed on a small form factor mobile device.

Scripts

For information about using scripts, see scripting guidelines for Base Form control.

Note:
- Description of controls placed on Base Form with Display Mode set as Grid is not displayed.
- Name set through scripts for controls placed on Base Form with Display Mode set as Grid is not displayed.
- Label of controls placed on Base Form is truncated if there are too many controls or if the label is too long.
- When a Base Form with the Default Number of Records set in a form, associated to a workflow with an Invoke Form activity to the same form, is used in Fill Form, and if all records for the Base Form are deleted while submitting the Fill Form, then, in the Invoke Form activity, the Base Form will continue to display the Default Number of Records.
- Adding records in Base Form is not supported for Chart, Slider and Hierarchical List controls.

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