5.2.2. Parameter List


5.2.2. Parameter List
Prev	5.2. Initialization Parameters	Next

The following tables show all of the initialization parameters available in the WebView application. The parameter names are not case sensitive, but the parameter arguments may be, depending on the meaning of the argument. The Properties column indicates whether the parameter can be set via a selection in the DataHub Properties window.

Connection

TcpPort

Value	Properties	Description
Integer	Advanced Options Data Port	The port number used to connect to the DataHub data feed. The default is `4502`.

WebPort

Integer Advanced Options The HTTP port number on which the DataHub Web Server is listening. The default is 80.

Host

String

Advanced Options

The name or IP address of the computer on which the DataHub instance is running.

DataProtocol

String Advanced Options There are two options: "TCP" or "WebSocket" to specify the data protocol. The default is "TCP".

UseSsl

True/False Advanced Options When True, the WebView application will use the SSL protocol for the TcpPort. The default is False.

UseHttps

True/False Advanced Options When True, the WebView application will use HTTPS for the WebPort. The default is False.

Credentials and Login

UserName

String

Running WebView

The user name. If this is specified then the WebView application will bypass the login screen and automatically log in using this user name.

Password

String Running WebView The password for UserName.

Start Page, Page Data, and Initial Editor Mode

Page

Value	Properties	Description
String	WebView	The WebView page to show when the user first logs in. This page will be loaded even if the user starts in Design mode. The page name must include any path components separated by `/` characters. The page name does not include an extension. Example: `Users/admin/mypage`

PageData

name=value pairs WebView These values become global variables in the script context. Each name=value pair is separated by a comma, as in: PageData=a=5,b=6. Please see Page Data in the WebView Scripting manual for more information.

StartInRunMode

True/False WebView When True, the WebView application will enter Run mode when the user logs in, otherwise it will enter Design mode if the user has permission to do so.

DisableDesignMode

True/False WebView When True, the WebView application will not allow the user to enter Design mode, even if the user has permission to do so. Also, when True, this parameter hides dialogs that require user interaction.

UseKioskView

True/False WebView When True, the WebView application will start in Kiosk mode, removing the menu and icon bars.

UseFullScreenMode

True/False WebView When True, the WebView application will start in Full Screen mode, displaying only the page.

RunSilently

True/False WebView When True, in Run mode only, this parameter hides dialogs that require user interaction. The default is False.

HideLoadingPageMessage

True/False WebView When True, in Run mode only, this parameter hides dialogs that do not require user interaction (such as any "Wait" dialog). For this to work, ForceNonInteractiveDialogs must be set to True and RunSilently to False. The default for this parameter is False.

ForceNonInteractiveDialogs

True/False No When True, in Run mode only, this parameter overrides the RunSilently parameter and displays non-interactive dialogs (such as any "Wait" dialog). The default is False.

FreezeScreenWhileLoadingPage

True/False No When True (the default), then the current page is frozen and the new page is loaded in the background. If this is False then the current page is erased and the new page is loaded in the foreground, with controls on the screen appearing as they load.

ShowExitConfirmation

UnsavedChanges, Never, Always No This setting determines whether to prompt the user when he attempts to exit the WebView application. If set to Never, then the user will not be prompted on exit. If set to Always then the user will be prompted. If set to UnsavedChanges then the user will only be prompted if there are unsaved changed on the current page. The default is Always.

Branding

BrandingFolder

Value	Properties	Description
String	WebView	The path to a folder to search for custom branding information. This folder is relative to the WebView installation `Branding` directory. The path separator is the `/` character.

Page Designer Functionality

DisablePageInformationButton

Value	Properties	Description
True/False	WebView	When `True`, the page information button will not be displayed in Run mode. The default is `False`.

MakeDataPointsReadOnly

True/False WebView When True, the WebView application will be unable to write data to the DataHub instance's data set, regardless of the configuration or user permissions. The default is False.

ShowHiddenControls

True/False No When True, controls that are normally hidden will be visible in Design mode. Hidden controls are controls that act as base classes for other controls, are deprecated, or are experimental. In any case, these controls should not be used by a page designer. The default is False.