DS Server

Javascript: ParagraphFormat.setFrameLineColor Method

Method|Introduced in 28.0

Description

Sets the color used for the frame lines of a paragraph.

Syntax

<void> ParagraphFormat.setFrameLineColor(<string> frameLineColor, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
frameLineColor

The color used for the frame lines of a 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.setFrameLineColor in a practical document-editing workflow. It sets the color used for the frame lines of a paragraph.

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

TXTextControl.paragraphFormat.setFrameLineColor(
    "#ffd54f",
    function() {
        console.log("set frame line color completed.");
    },
    onTxError
);