TX Text Control .NET Server

Javascript: ParagraphFormat.setFrameLineWidth Method

Method|Introduced in 26.0

Description

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

Syntax

<void> ParagraphFormat.setFrameLineWidth(<number> frameLineWidth, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
frameLineWidth

The line width, in twips, of 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.setFrameLineWidth in a practical document-editing workflow. It sets 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.setFrameLineWidth(
    1440,
    function() {
        console.log("set frame line width completed.");
    },
    onTxError
);