Description

Sets the framesetting of the paragraph.

Syntax

<void> ParagraphFormat.setFrame(<Frame> frame, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
frame	The framesetting of the paragraph.
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.setFrame in a practical document-editing workflow. It sets the framesetting of the paragraph.

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

TXTextControl.paragraphFormat.setFrame(
    TXTextControl.Frame.LeftLine,
    function() {
        console.log("set frame completed.");
    },
    onTxError
);