Description

Gets the descriptive text for the frame. An empty string indicates that the frame has no such text.

Syntax

<void> FrameBase.getDescriptiveText(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates FrameBase.getDescriptiveText in a practical document-editing workflow. It gets the descriptive text for the frame. An empty string indicates that the frame has no such text.

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

function inspectDescriptiveText(frameBase) {
    frameBase.getDescriptiveText(
        function(result) {
            console.log("get descriptive text result:", result);
        },
        onTxError
    );
}