TX Text Control .NET Server

DocumentViewerSettings Class

Class

Description

Initial settings accepted by `DocumentViewerElement` and `DocumentViewerController`. Nested options are documented as DocumentLoadSettings, SignatureSettings, and OAuthSettings.

Syntax

DocumentViewerSettings

Members

Properties

PropertyDescription
basePathBase URL used for server-side document endpoints.
customQueryParamsAdditional query parameters sent to server-side document endpoints. Endpoint-specific values take precedence, and `access_token` is reserved for OAuth handling.
dockInitial dock style: `0` for window mode or `1` for fill mode.
documentDataBase64-encoded document loaded automatically during initialization.
documentLoadSettingsProvider settings for the automatically loaded document.
documentPathDocument name or path associated with `documentData`.
formattingPrinterFormatting-printer identifier sent to the document provider.
oauthSettingsOAuth settings for requests to server-side document endpoints.
renderModeRendering mode: `0` automatic, `1` fonts, `2` glyph outlines, or `4` bitmaps.
resourcesLocalized viewer strings keyed by their `TX_*` resource names.
showThumbnailPaneWhether the left sidebar is initially visible in desktop mode.
signatureSettingsSignature settings for the automatically loaded document.
toolbarDockedWhether the desktop toolbar is docked to the viewer.
userNamesUser names available to annotation and comment workflows. The first entry is treated as the current user.
viewViewer mode: `0` mobile, `1` desktop, or `2` automatic detection.