Web Browser View Properties

The text that appears on the view tab or title bar after the view builds or refreshes. If no value is specified, the CaptionBeforeBuild value is used. If no CaptionBeforeBuild value is specified, the view name is used.

The value can be tokenized, which allows the caption to reflect the current context. For example, if the view has selectors and the CaptionAfterBuild contains a token for each of the selectors, the caption after the view is built or refreshed reflects the selections represented by the view data.

See also: CaptionBeforeBuild

The text that appears on the view tab or title bar when the view is opened and before the view builds for the first time. If no value is specified, the view name is used as the caption.

The value can be tokenized.

See also: CaptionAfterBuild

false

Controls whether only a single instance of the view can be opened by the user from the view selector. When the setting is True, only a single instance is allowed. When the user attempts to open another instance of the view from the view selector, the existing view’s window is activated.

false

Controls whether the view can be saved by a user. If true, the Save View As and Save View button tools are enabled.

false

Controls whether a saved view can be shared by the owner.

AllowSharing is only applicable when AllowSave is true.

See also: AllowSave

false

Controls whether the view automatically builds when opened.

If true, the view automatically builds, but only if the view is buildable. Whether or not the view is buildable is based on the view state. For instance, if a view has selectors and each selector has a selection, the view is buildable.

false

Controls whether cookies set by the CookieCollections of WebBrowser views are cleared before building the view. This property is used when cookies are set for this or other WebBrowser views set cookies that may interfere with the running of this view.

true

Controls whether the WebBrowser view will suppress JavaScript errors that occur when a page loads. This property can be set to true in order to mimic modern web browsers, which suppress errors by default.

BrowserType.BestAvailable

Controls the browser engine that will be used to render the view.

WebBrowser - The Internet Explorer WebBrowser control.
WebView - The Edge WebView2 control.
BestAvailable - The Edge WebView2 control if available, otherwise the Internet Explorer WebBrowser control.

The serialized CookieCollection used by the browser.

HTML to render in the browser. If HTML is set, it will override the value of URL.

The URL to navigate to.

The collection of components that are added to the view upon initialization. Component configurations define properties for component plugins that interact with this view.

The Notes property can be used by developers to record information related to the view, such as notes about the design, history of changes, etc.

A data string that will be posted to the specified URL before rendering the response in the browser. If the HTML property is set, the data will not be posted.

See also: PostDataEncoding, PostDataContentType

WebBrowserEncoding.UTF8

The encoding utilized when sending any PostData content.

See also: PostData, PostDataContentType

Primarily used for specifying the "Content-Type" header of the PostData. In addition to the "Content-Type" header, additional HTTP headers may be sent with the initial web request. If no header name or names are indicated, the value of this property will be sent as the "Content-Type". If left blank, the default content type will be "application/x-www-form-urlencoded". The following represent valid PostDataContentType values:

Example #1 — application/json Example #2 — Content-Type: application/x-www-form-urlencoded Example #3 — Authorization: Basic ZG9kZWNhOnlLZU1lM1QvNCtIcXFwJ2U= Content-Type: application/x-www-form-urlencoded

See also: PostData, PostDataEncoding

Controls which selectors are displayed for the view and specifies configuration settings for each selector, including 1) the selector list and the connection used to populate the selector, 2) a toggle that controls whether the user is allowed to select multiple items from the selector, and 3) an optional caption that overrides the default caption.

SelectorControlUIDisplayMode.DockedControl

Controls whether a docked pane or a modal dialog contains the user-interface control that displays the selectable items. The setting is only applicable to selectors that display the items in a user-interface control, such as a treeview or listbox, when the user clicks the 'Show' button on the selector tool.

DockedControl — Displays a pane that contains the user-interface control. The pane is docked the first time the user clicks the 'Show' button. The docked location is specified by the SelectorDockedControlLocation. If multiple selector user-interface controls are docked, each is displayed as a separate tab in the pane.

LockedDockedControl — Same as a DockedControl, except that the user cannot move the control to a different docked location.

ModalDialog — Displays a modal dialog that contains the user-interface control. The dialog is displayed each time the user clicks the 'Show' button, and must be closed by the user.

See also: SelectorDockedControlLocation

DockedControlGroupStyle.Tabbed

The layout of the group of dockable selector user-interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

Tabbed - Each selector control is displayed as a tabbed window within the group. Only the content of the selector control that is displayed in the active tab is visible.

Stacked - The selector controls are displayed as stacked tiles.

SlidingHeaders - Each selector control is represented by a button and only the content of the active selector control is visible. A selector control is activated by pressing its button.

SideBySide - The selector controls displayed as side-by-side tiles.

The combination of the SelectorDockedControlLocation and SelectorDockedControlGroupStyle settings determines the location and layout of the selector controls.

See also: SelectorControlUIDisplayMode, SelectorDockedControlLocation

DockedControlLocation.Right

The initial docked location for dockable selector controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

LastUsedItemContextScope.BySelector

Controls the caching of the item(s) selected when the view is built. The cache is used to determine the default selected item(s) for the selectors that are assigned a selector list with a DefaultSelectionPolicy of LastUsedItem.

BySelector - The cache is shared by all views configured with the BySelector context. BySelectorList - The cache is shared by all views configured with the BySelectorList context. ByView - The cache is used only by this view. ByLabel - The cache is shared by all views configured with the ByLabel context and assigned the same SelectorLastUsedItemContextLabel as this view.

The context label used when the SelectorLastUsedItemContext is set to ByLabel. Views that are assigned the same label share the same default selections.

StatusBarContentAlignment.Center

Controls the alignment of the progress text within the progress text area on the status bar.

ProgressTextAlign is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowProgressText

true

Controls whether the progress bar is displayed in the status bar when downloading. Use the ShowStatusBar setting to control whether the status bar is displayed in the view window.

true

Controls whether the progress text is displayed in the status bar. ShowProgressText is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ProgressTextAlign

true

Controls whether the status bar is displayed in the view window.

See also: ShowStatusIcon, ShowStatusText, ShowProgressText, ProgressTextAlign

true

Controls whether the status icon is displayed in the status bar. ShowStatusIcon is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowStatusText

true

Controls whether a status icon is displayed on the view window tab.

true

Controls whether the status text is displayed in the status bar. ShowStatusText is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowStatusIcon

Ready to Build

The text displayed in the status bar to indicate the view is buildable as determined by the view state. For instance, a view that has selectors is typically considered buildable when each selector has a selected item.

Cancelled

The text displayed in the status bar to indicate the view was cancelled.

Error

The text displayed in the status bar to indicate a view operation failed.

Information

The text displayed in the status bar to indicate that the status details contain information. The details are displayed when the Details button is clicked.

Not Ready to Build

The text displayed in the status bar to indicate the view is not buildable as determined by the view state.

Ready

The text displayed in the status bar to indicate a view operation is complete.

Waiting for Server Response

The text displayed in the status bar to indicate the view is waiting for a response from the server.

Warning

The text displayed in the status bar to indicate that the status details contain a warning. The details are displayed when the Details button is clicked.

Working

The text displayed in the status bar to indicate a view operation is processing.

The token definitions assigned to the view. The view tokens along with the application tokens and, if applicable, selector tokens are used during token replacement.

The ID of the toolbars configuration that defines the view-specific menus and tools. At run-time, the menus and tools are merged with the application menus and tools.

See also: ViewToolbarsConfigurationID

The ID of the toolbars configuration that defines the view-specific menus and tools displayed within the view window.

See also: MergeableToolbarsConfigurationID

The object type ID of the Windows form that contains the user-interface controls used to display the view data.

This is a required setting.

The caption for the View Help window.

SelectorControlUIDisplayMode.DockedControl

Controls whether a docked window or a modal dialog contains the view help.

DockedControl — Displays a docked window that contains the view help. The window is docked the first time the window is displayed. The DockedControlLocation indicates along which side the window is located.

LockedDockedControl — Same as a DockedControl, except that the user cannot move the window to a different docked location.

ModalDialog — Displays a modal dialog that contains the view help. The dialog is displayed each time the user clicks the 'View Help' button, and must be closed by the user.

true

Whether to display the View Help dockable window when the view is opened.

DockedControlLocation.Right

When the DisplayMode is DockedControl or LockedDockedControl, indicates the initial docked location for the view help window.

The ID and version of the RTF binary artifact that contains the help content.

Most of the rich text formatting is supported in the View Help control, including font sizes, colors, underlines, strike-throughs, italics, bolding, and highlights as well as bulleted and numbered lists, paragraph alignment, indentation, and images.

Custom functionality in the View Help content includes: - A Worksheet Navigation Link navigates to a specified address in the workbook. The link address is GoTo|<worksheet address>, such as GoTo|'Product Analysis'!$C$10. - A Tool Click Link triggers a click action for a specified tool key. The link address is ToolClick|<tool key>, such as ToolClick|SaveView. The tool can be visible or hidden. - Workbook script functions can be included in the content. - Tokens can be included in the content.

The workbook script functions and tokens are resolved when the control is opened, and, if the RefreshOnViewBuild view setting is True, also when the view builds.

false

Whether to refresh the View Help after the view is built.