SetKeepLines

function SetKeepLines(isKeepLines: boolean = null): void

Description

Specifies that when rendering the document using a page view, all lines of the current paragraph are maintained on a single page whenever possible.

Parameters

isKeepLinesbooleandefault: null

The true value enables the option to keep lines of the paragraph on a single page.

Returns

void

Try It

var oDocument = Api.GetDocument();
var oMyStyle = oDocument.CreateStyle("My document style");
var oParaPr = oMyStyle.GetParaPr();
oParaPr.SetKeepLines(true);
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is an example of how the paragraph tries to keep lines together. ");
oParagraph.AddText("Scroll down to the second page to see it.");
for (let x = 0; x < 5; ++x) {
   oParagraph = Api.CreateParagraph();
   for (let i = 0; i < 10; ++i) {
   	oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
   }
   oDocument.Push(oParagraph);
}
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The paragraph lines are moved to the next page to keep them together. ");
for (let i = 0; i < 10; ++i) {
   oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
}
oParagraph.SetStyle(oMyStyle);
oDocument.Push(oParagraph);

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).