Description

Sets a value indicating whether a page break is allowed within the paragraph.

Syntax

<void> ParagraphFormat.setKeepLinesTogether(<boolean> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	Specifies whether a page break is allowed within 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.setKeepLinesTogether in a practical document-editing workflow. It sets a value indicating whether a page break is allowed within the paragraph.

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

TXTextControl.paragraphFormat.setKeepLinesTogether(
    true,
    function() {
        console.log("set keep lines together completed.");
    },
    onTxError
);