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 UpdatedJan 13, 2022
  • 2 minute read

Use scripts to set and get values for the properties of the Base Form control.

Basic

Property

Scripting Supported

Example

Name

Yes

Writable

Readable

To set the property

control.findById("ID").tagName = "Value for Name";

To get the value of the property

control.findById("ID").tagName;

XML Node

Yes

Readable

To get the value of the property

control.findById("ID").xmlNodeBoundTo;

Description

Yes

Writable

Readable

To set the property

control.findById("ID").description = "Value for Description";

To get the value of the property

control.findById("ID").description;

Appearance

Property

Scripting Supported

Script

Visible

Yes

Writable

Readable

To set the property

control.findById("ID").visible = true;

To get the value of the property

control.findById("ID").visible;

Label Position

No

Not Applicable

Label-Control Area

No

Not Applicable

Retain Space

No

Not Applicable

Display Mode

No

Not Applicable

Records Caption

No

Not Applicable

Record Position

No

Not Applicable

Image Path

No

Not Applicable

Adapt UI

No

Not Applicable

Custom Style Sheet Identifier

No

Not Applicable

Validation

Property

Scripting Supported

Example

Show Confirmation Message

No

Not Applicable

Confirmation Message

No

Not Applicable

Repeating

No

Not Applicable

Minimum Records

No

Not Applicable

Maximum Records

No

Not Applicable

Advanced

Property

Scripting Supported

Example

On Record Add

Yes

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

On Record Delete

Yes

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

ID

No

Not Applicable

Behavior

Yes

To set the property

control.findById("ID").readEditBehaviour = readEditBehaviourEnum.editable;

control.findById("ID").readEditBehaviour = readEditBehaviourEnum.readOnly;

OR

control.findById("ID").readEditBehaviour = readEditBehaviourEnum.allowOnlyAdd;

OR

To get the value of the property

control.findById("ID").readEditBehaviour;

Default Number of Records

No

Not Applicable

Fast Append

No

Not Applicable

Scripts

Property

Scripting Supported

Example

Name

Yes

return "Value for Name";

Description

Yes

return "Value for Description";

Visible

Yes

return true;

For more information, see scripting guidelines for Visible property.

Behavior

Yes

For more information, see scripting guidelines for Behavior property.

Record Visible

Yes

For more information, see scripting guidelines for Record Visible property.

Note:
- In a Form with Delay Loading enabled, Chart, Slider, Card, and Hierarchical List controls inside a container are not supported.
- The Chart control loads in the Inbox only when the Repeating property of the Base Form is set to False.

Updating Column Names in a Base Form with Display Mode set to Grid

You can update the column name for a Base Form with Display Mode set to Grid by updating the Tag Name of the control present in the column.

For more details, see Update Column Names in a Base Form.

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