Description

Gets an optional file description.

Syntax

<void> EmbeddedFile.getDescription(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates EmbeddedFile.getDescription in a practical document-editing workflow. It gets 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.getDescription(
            function(result) {
                console.log("get description result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);