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

AVEVA™ Work Tasks

Widget

  • Last UpdatedJun 22, 2023
  • 5 minute read

Use Widget control to create reusable graphical components. You can maintain a library of widgets for the other users to use.

Note: If you add or modify any standard widget files, it should be manually added to the package in the 'Additional files' section of the packages.

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.

Default Value

The default value for the control.

Widget Type

Select the widget type from the drop-down list. The widget types available are: Inline, Embed, and Form.

Widget

Select the available widget.

This property is available when the selected widget type is Inline and Embed.

Configuration

Select the available configuration.

This property is available when the selected widget type is Inline and Embed.

Form Details

Applicable for Form widget type. Provide the Form Details.

To select the form,

  1. In the Form Name box, select a form name.

  2. In the Form Version box, select a form version.

  3. Click Save & Continue. The selected form is embedded in the widget, and the Form Details Configuration page is closed.

    For more information, see Configure Communication between Widget Control and Form.

Appearance

Property

Description

Style

Height and Width in pixels for the control.

The default value for Height and Width is 0.

Note: If the value is 0, then the height and width of the control is set as per the default values.
- The characters < > & are not supported.
- The only supported value for height and width is the pixel.

In Designer

Option to view the space taken by the Widget as per the Style property in Design mode.

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 Suppress.

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.

Consider Available Height

Resize the height of the control or container based on the available height.

  • Select Yes to resize the height based on available height.

  • Select No to retain the space.

    The default value is No.

Note:
- The Consider Available Height property is not applicable for the following:
-Designer view
-Print form
-Panel form with horizontal tab order
- If this property is set to Yes and a value is specified in the Height property, minimum height is considered.
- This property is applicable only in web view.
- When more than one control or container is set with Consider Available Height at the same level of container or form, then the available space is distributed evenly between those controls or containers.
For example, consider a Form which contains two Panel forms with Consider Available Height set to Yes, where Panel form 1 has two TextInput controls and Panel form 2 has one TextInput control. The Panel form 1’s height is more than Panel form 2’s height as Panel form 1 contains two TextInput controls and the available empty space in the form is evenly distributed between the two Panel forms.

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.

Custom Style Sheet Identifier

Prefix for the CSS class name in the custom style sheet.

For information about using custom style sheets, see Custom Styles.

Note: The value must start with an alphabet and can contain only alphanumeric characters.

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.

Add Values as Url

Option to add values as URL parameters.

Widget Properties

The widget properties are listed based on the Widget selected in the control, when the Widget Type is Inline or Embed. See the respective Widget documentation for the available widget properties.

Scripts

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

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