Description

Sets an optional file description.

Syntax

<void> EmbeddedFile.setDescription(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The 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 EmbeddedFile.setDescription in a practical document-editing workflow. It sets an optional file description.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const embeddedFiles = mainText.embeddedFiles;
    embeddedFiles.getItem(function(embeddedFile) {
        if (!embeddedFile) {
            console.warn("No embedded file is available at the current input position.");
            return;
        }
    
        embeddedFile.setDescription(
            "Invoice line items",
            function() {
                console.log("set description completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);