@txtextcontrol/tx-react-document-viewer

TX Text Control Document Viewer (React version)

This library provides a document viewer compatible with TX Text Control and documents created using the Document Editor and API of TX Text Control.

Prerequisites

The TX Text Control Document Viewer uses a backend that runs TX Text Control.NET Server for ASP.NET. Please use the MVC package for ASP.NET and ASP.NET Core Web Applications.

TXTextControl.Web.DocumentViewer.

Usage

Your App.js could look like this, for example (the only mandatory attributes are width, height and basePath):

import DocumentViewer from '@txtextcontrol/tx-react-document-viewer'

[...]

<DocumentViewer
   width="1280px"
   height="1024px"
   basePath="https://backend.textcontrol.com?access-token=yourtoken"
   documentData="SGVsbG8gdGhlcmU=">
</DocumentViewer>

Possible attributes

• width (string) - The width of the component (e. g. "1024px").
• height (string) - The height of the component (e. g. "1024px").
• basePath (string) - The backend server that is running TX Text Control .NET Server for ASP.NET.
• documentData (string) - Base64 encoded document data.
• documentPath (string) - The displayed document name.
• documentLoadSettings (DocumentLoadSettings) - Additional settings for loading the passed document.
• 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.
• signatureSettings (SignatureSettings) - The signature settings. See below.
• onLoad (function) - Is executed as soon as the main 'TXDocumentViewer' object is loaded.

DocumentLoadSettings Object

The DocumentLoadSettings object has the following properties:

• loadEmbeddedComments (boolean) - Specifies whether comments from the document should be loaded as annotations.
• pdfjs (PDFJSSettings) - Specifies whether comments from the document should be loaded as annotations.

PDFJSSettings Object

The PDFJSSettings object has the following properties:

• workerSourcePath (string) - Specifies the worker source path.
• librarySourcePath (string) - Specifies the libraray source path.

SignatureSettings Object

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

SignatureBox Object

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.