TX Text Control .NET Server

Javascript: ParagraphFormat.getFrameLineWidth Method

Method|Introduced in 26.0

Description

Gets the line width, in twips, of the paragraph's frame.

Syntax

<void> ParagraphFormat.getFrameLineWidth(<RequestNumberCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the line width, in twips, of the paragraph's frame.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates ParagraphFormat.getFrameLineWidth in a practical document-editing workflow. It gets the line width, in twips, of the paragraph's frame.

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

TXTextControl.paragraphFormat.getFrameLineWidth(
    function(result) {
        console.log("get frame line width result:", result);
    },
    onTxError
);