Description

Sets the document link's descriptive text. An empty string or null can be used to delete a previously set text.

Syntax

<void> DocumentLink.setDescriptiveText(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The new property value.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates DocumentLink.setDescriptiveText in a practical document-editing workflow. It sets the document link's descriptive text. An empty string or null can be used to delete a previously set text.

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.setDescriptiveText(
            "Quarterly report",
            function() {
                console.log("set descriptive text completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);