Javascript: DocumentViewerController.loadDocument Method

Description

Loads a Base64-encoded document and replaces the currently displayed document.

Syntax

<Promise.<boolean>> DocumentViewerController.loadDocument(<DocumentData> documentData, [<string> docName], [<SignatureSettings> signatureSettings], [<DocumentLoadSettings> documentLoadSettings])

Parameters

Parameter	Description
documentData	Base64-encoded data without a data-URL prefix.
docName	Optional. Document name, optionally including a path or extension.
signatureSettings	Optional. Document-specific signature settings.
documentLoadSettings	Optional. Provider-specific load settings.

Return Value

`true` after a successful load, otherwise `false` for handled failures.

Examples

The following example demonstrates TXDocumentViewer.loadDocument in a practical Document Viewer workflow. Loads a document from memory into the DocumentViewer. The document must be passed as an Base64 encoded string. The format is recognized automatically.

async function loadContract(documentBase64) {
    const signatureSettings = {
        showSignatureBar: true,
        ownerName: "Contoso Legal",
        signerName: "Alex Reviewer",
        signerInitials: "AR",
        signatureBoxes: [
            { name: "CustomerSignature", signingRequired: true, style: 0 }
        ]
    };
    const loadSettings = { loadEmbeddedComments: true };

    const loaded = await TXDocumentViewer.loadDocument(
        documentBase64,
        "contract.docx",
        signatureSettings,
        loadSettings
    );
    console.log("Contract loaded:", loaded);
}