Description

Sets the distance, in twips, between the text and the paragraph's frame.

Syntax

<void> ParagraphFormat.setFrameDistance(<number> distance, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
distance	The distance, in twips, between the text and the paragraph's frame.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates ParagraphFormat.setFrameDistance in a practical document-editing workflow. It sets the distance, in twips, between the text and the paragraph's frame.

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

TXTextControl.paragraphFormat.setFrameDistance(
    1440,
    function() {
        console.log("set frame distance completed.");
    },
    onTxError
);