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

AVEVA™ Work Tasks

Embed Form

  • Last UpdatedJun 25, 2024
  • 5 minute read

Use Embed Form control to use the entire form as a part of another form. You can design the common section in a Form and use it in other forms through the Embed 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.

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.

Form Details

Details of the form that is to be linked.

To add Form Details for the control

  1. Click the Form Details button. The Form Details Configuration page appears.

  2. In the Form Name box, click a form name.

  3. In the Form Version box, click a form version.

  4. Click Save & Continue. The selected form details is set for the control, and the Form Details Configuration page is closed.

    Note:
    - Embed Form control does not support forms with Embed Form controls.
    -We recommend using unique XML nodes for controls in source forms to aid in scripting.
    - We recommend using the control.findByXmlNode() method instead of the control.findById() method in source forms to avoid conflict of IDs between forms.
    -The definition of the source form is fetched and used for the embed form. The source form is no longer referenced after the properties of the control are saved. Therefore, the source form does not have to be available in the repository after the properties are configured.
    - If both the main and embed form contains pop-up control, then ensure that the IDs are different.
    - The draft version of the selected form is considered.

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.

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.

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.

Show Panel Details

Show or hide the Title, Description, and Margin.

  • Select Yes to show the panel details.

  • Select No to hide the panel details.

    The default value is Yes.

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.

Advanced

Property

Description

ID

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

Scripts

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

Note:
- This control might impact performance as the data loaded determines the performance of the control.
- If the form specified in the Embed Form control, contains an On Form Load script, then the script does not get executed. To overcome this, use a Hidden Field control with the script added to the value script.
- Embed Form control does not support forms with Embed Form controls.
- Embed Form is not supported in Panel Form when with Tab Order set to Horizontal.
- Embed Form is not supported for MQTT.

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