@thomerow/tx-ng-ds-document-viewer

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

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">
</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.
• 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 (string[]) - Specifies resources for the displayed strings.
• signatureSettings (object) - The signature settings. See below.

Signature settings

The signature settings object has the following properties:

• ownerName (string) - The owner name.
• signatureBoxName (string) - The id of the signature box element
• 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.

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.');
}