@txtextcontrol/tx-ng-ds-document-viewer v3.5.0

TX Text Control Document Services Document Viewer (Angular version)

This library provides a document viewer compatible with TX Text Control DS Server and documents created using the editor and API of TX Text Control.

Installation

ng add @txtextcontrol/tx-ng-ds-document-viewer

Important notice: From Angular v17 onwards, "standalone" apps are the new default for the CLI. If you want DocumentViewerModule to be added to your app.module.ts automatically, you have to use the --no-standalone flag when creating a new Angular project with ng new. Standalone applications created without this flag will show the error Bootstrap call not found when using the ng add command.

Usage

Your component.html could look like this, for example (the only mandatory attributes are width, height and serviceURL):

<tx-ds-document-viewer
   width="1280px"
   height="1024px"
   serviceURL="https://your.server.com/documentservices"
   documentData="SGVsbG8gdGhlcmU="
   oauthClientID="dsserver.PdRpDAnzGLRrTPhRnYBU2UAEkzyB4PQ1"
   oauthClientSecret="HgpGyqoFQOVkrzk6ukHtSxUS6XdU39LP"
   [customQueryParams]='{ "param1": "Param1Value", "param2": 42 }'>
</tx-ds-document-viewer>

Possible attributes

• width (string) - The width of the component (e. g. "1024px").
• height (string) - The height of the component (e. g. "1024px").
• serviceURL (string) - The server which is hosting your installation of Text Control DS Server.
• oauthClientID (string) - The OAuth client ID.
• oauthClientSecret (string) - The OAuth client secret.
• documentData (string) - Base64 encoded document data.
• documentPath (string) - The displayed document name.
• userNames (string[]) - An array of names specifying users who have access to editable regions.
• isSelectionActivated (boolean) - Specifies whether text can be selected and copied.
• dock (string) - Specifies how the control is docked. Possible values are 'Fill' and 'Window'.
• toolbarDocked (boolean) - Specifies whether the toolbar is docked or floating.
• resources (Object.<string, string>) - Specifies resources for the displayed strings.
• accessToken (string) - An (OAuth-) access token acquired through a self implemented workflow. When this attribute is present, oauthClientID and oauthClientSecret are ignored.
• signatureSettings (object) - The signature settings. See below.
• customQueryParams (Object.<string, any>) - Specifies user-definable query parameters which are added to the query string of each HTTP request.

Signature settings

The signature settings object has the following properties:

• ownerName (string) - The owner name.
• signatureBoxName (string) - The id of the signature box element. Deprecated. Use the signatureBoxes property instead.
• signerName (string) - The signer name.
• signerInitials (string) - The signer initials.
• showSignatureBar (boolean) - Specifies whether to show the signature bar.
• uniqueId (string) - The unique signature id.
• redirectUrlAfterSignature (string) - The URL to redirect to after a signature.
• customSigning (boolean) - Specifies whether the signing process is handled within custom code.
• signatureBoxes (object[]) - Boxes for signing (see below). Property signatureBoxName has no effect if this array is not empty.

Signature boxes

A signature box object has the following properties:

• style (string) - The signature box style. Possible values are "Signature" and "Initials". The default value is "Signature".
• signingRequired (boolean) - Specifies whether signing is required. The default value is true.

Events

Because the script containing the main TXDocumentViewer object is loaded in a deferred manner, the component provides a global event ("dsDocumentViewerLoaded") which is fired as soon as the object is available. The event is dispatched on the document object. You can subscribe to it in your component.ts as follows:

@HostListener('document:dsDocumentViewerLoaded')
onDsDocumentViewerLoaded() {
   console.log('The TXDocumentViewer object exists from now on.');
}

Environment Support

• Angular ^15.2.3 or higher
• TX Text Control DS Server version 3.5.0 or higher.