PDF 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.

true

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 the view will attempt to detect whether a PDF document is an unsupported portfolio-type PDF and present the user with the opportunity to open it in an external viewer.

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.

100%

The default zoom level for the document to be displayed on the view’s initial build.

The default zoom is specified by using a combination of the DefaultZoom and DefaultZoomMode settings. The DefaultZoom level is used, provided that the DefaultZoomMode setting is Default.

See also: DefaultZoomMode

ZoomMode.Default

The default zoom mode for the document to be displayed on the view’s intitial build.

Default — Displays the document based on the value of DefaultZoom setting.

FitPage — Displays the document so that an entire page can be displayed in the open window.

FitWidth — Displays the document so that the page fills the width of the open window.

See also: DefaultZoom

1

The page of the PDF document to be displayed on the view’s initial build.

The SQL connection ID used to look up the metadata that defines the JDBC settings used when connecting to the relational database.

The SelectSQL statement is used to retrieve a blob from the relational database. The following guidelines apply:

 — The SELECT statement must use the native syntax supported by the database.

 — The statement can be tokenized. A tokenized SELECT statement is used, for instance, when the statement contains a WHERE clause that defines the search criteria for rows by including one or more selector tokens, such as “WHERE Sales.SalesOrderDetail.ProductID IN ([T.Product])” where [T.Product] is a comma-delimited list of product ID’s.

The PDF file to be displayed can be specified using any of the following settings: SQLConnectionID/SelectSQL, PDFBinaryArtifact, or URL. The SQLConnectionID/SelectSQL settings take precedence, followed by the PDFBinaryArtifact setting, followed by the URL setting. When SQLConnectionID/SelectSQL settings are specified, the PDFBinaryArtifact and URL settings are not used.

See also: PDFBinaryArtifact and URL

The URL of the internet resource or local PDF file to navigate to.

The PDF file to be displayed can be specified using any of the following settings: SQLConnectionID/SelectSQL, PDFBinaryArtifact, or URL. The SQLConnectionID/SelectSQL settings take precedence, followed by the PDFBinaryArtifact setting, followed by the URL setting. When SQLConnectionID/SelectSQL or PDFBinaryArtifact settings are specified, the URL is not used.

See also: SQLConnectionID, SelectSQL, and PDFBinaryArtifact

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.

Downloading

Downloading…​

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.

PDF

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.