ViewApp Namespace Attributes
Use attributes in the ViewApp namespace to show a Windows on-screen keyboard, and to set a ViewApp to read/write or read-only. The full attribute name is MyViewApp.<attribute name>.
| Attribute Name | Description | Data Type |
Read/ Write |
|---|---|---|---|
| AllowBrowserTools | This attribute is for use with apps that use the WebControl API. If this attribute is set to true, the ShowDevTools and HideDevTools methods in the WebControl API are enabled. This allows an app user to press the F12 key to show (on first key press) or hide (on next press) the Developer Tools window in their browser. Some browsers, notably Chrome and Firefox, also allow the Shift + Ctrl + I key combination to show/hide Developer Tools, but this is not supported in OMI apps. Only the F12 key is enabled when this attribute is true. The default is false. The attribute is retentive. | Boolean | R/W |
| UseWindowsOnScreenKeyboard | This attribute is for use with the TitleBar App, which includes a built-in keyboard. If the TitleBar App keyboard property is enabled, this attribute determines which keyboard is displayed. Displays the standard Windows on-screen keyboard if true, or an AVEVA OMI on-screen keyboard if false. Default is true. The attribute is retentive. | Boolean | R/W |
| ReadOnly |
Determines if a ViewApp is read/write or read-only. When true, the ViewApp opens as read-only. This value is set to true by selecting the "Read Only" option while launching the ViewApp from the AVEVA OMI Application Manager. Default is false (read/write). Note: If the ViewApp is assigned to a ViewEngine, and the ViewAppReadOnly attribute on the ViewEngine is set to true, the ReadOnly attribute in the Settings namespace has no affect. The ViewApp will open as read-only, even if you select Read/Write when opening the ViewApp. |
Boolean | Read |
These ViewApp attributes return information about a running ViewApp. The full attribute name is MyViewApp.ViewAppInfo.<attribute name>.
| Attribute Name | Description | Data Type |
Read/ Write |
|---|---|---|---|
| ViewAppInfo.Name | This attribute returns the deployed ViewApp name. In preview mode, Name will show as "Preview." | String | Read |
| ViewAppInfo.Version | This attribute returns the deployed ViewApp version. | String | Read |
| ViewAppInfo.Template | This attribute returns the template name of the deployed ViewApp. This also works in preview mode. | String | Read |
| ViewAppInfo.ViewEngine | This attribute returns the name of the ViewEngine that contains the deployed ViewApp. | String | Read |
| ViewAppInfo.Platform | This attribute returns the name of the platform that hosts the deployed ViewApp. | String | Read |
| ViewAppInfo.Galaxy | This attribute returns the name of the galaxy that contains the deployed ViewApp. | String | Read |
| ViewAppInfo.GRNode | This attribute returns the name of the GR node name that contains the deployed ViewApp. | String | Read |
| ViewAppInfo.Client | This attribute returns the client name where OMI is running. For RDP clients, this returns the client name and not the RDP server name. | String | Read |
Note: The ReadOnly attribute was in the Settings Namespace in prior releases. As of the System Platform 2020 release, the attribute has been moved to the ViewApp namespace, but also remains in Settings to maintain backward compatibility. The ReadOnly flag in Settings has been deprecated and should point to ReadOnly in ViewApp. It will be removed in a future release.