Embed Page
- Last UpdatedNov 07, 2024
- 4 minute read
Use Embed Page control to show a webpage in your form.
Note:
- The Embed Page control uses an iframe to load the url. If the source Url has an
HTTP Response header X-Frame-Options, it might not load in the Embed Page control.
Refer to X-Frame-Options documentation on the W3C website.
- Setting a source other than the Enterprise Console Web Application may prevent the
content from loading due to security settings configured in the Enterprise Console's
web.config file as part of the Content Security Policy (CSP). You can update the CSP by adding
the directive frame-src to support embedding pages from other source URLs within the Enterprise Console.
- This control is not supported in AVEVA Work Tasks Pro.
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. |
|
Description |
Description for the control. |
|
URL |
URL for the webpage for the control. Start the URL with http:// or https:// or the path with the <BPMUITemplates> tag. The <BPMUITemplates> tag replaces the path with the application path including the Default folder. For example, <BPMUITemplates>/Report.html is replaced as /EnterpriseConsole/BPMUITemplates/Default/Report.html |
Appearance
|
Property |
Description |
|---|---|
|
Visible |
Show or hide the control.
|
|
Label Position |
Position of the label for the control.
Note: |
|
Label-Control Area |
Area occupied by the label and the control in percentage.
Note: |
|
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.
Note: |
|
Retain Space |
Reserve or remove space when the control is hidden.
|
|
Show Scrollbars |
Show or hide scrollbars for the control.
|
|
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. On Data Change script always works with the value script for the Embed Page. To set the Embed Page Url and also trigger the Embed Page’s On Data Change script, see Set Embed Page Url and Trigger the On Data Change Script. 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. |
Scripts
For information about using scripts, see scripting guidelines for Embed Page control.
Note: This control might impact performance as the data loaded determines the performance of the control.