Description

Sets a descriptive text for the text frame. An empty string or null can be used to delete a previously set text.

Syntax

<void> TextFrame.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 TextFrame.setDescriptiveText in a practical document-editing workflow. It sets a descriptive text for the text frame. 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;
}

function configureDescriptiveText(textFrame) {
    textFrame.setDescriptiveText(
        "Quarterly report",
        function() {
            console.log("set descriptive text completed.");
        },
        onTxError
    );
}