DocumentLink Object

Description

The DocumentLink object represents a text position in a Text Control document that is a target of a document link.

Syntax

DocumentLink

Examples

The following example demonstrates DocumentLink in a practical document-editing workflow. The DocumentLink object represents a text position in a Text Control document that is a target of a document link.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const documentLinks = mainText.documentLinks;
    documentLinks.getItem(function(documentLink) {
        if (!documentLink) {
            console.warn("No document link is available at the current input position.");
            return;
        }
    
        documentLink.getAutoGenerationType(
            function(result) {
                console.log("get auto generation type result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);

Members

Methods