Description

Gets the width, in twips, of a text frame's border line.

Syntax

<void> TextFrame.getBorderWidth(<RequestNumberCallback> 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 TextFrame.getBorderWidth in a practical document-editing workflow. It gets the width, in twips, of a text frame's border line.

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

function inspectBorderWidth(textFrame) {
    textFrame.getBorderWidth(
        function(result) {
            console.log("get border width result:", result);
        },
        onTxError
    );
}