AddBreak

function AddBreak(breakType: number = null, position: string = null): boolean

Description

Inserts a break at the specified location in the main document.

Parameters

breakTypenumberdefault: null

The break type: page break (0) or line break (1).

positionstringdefault: null

The position where the page or line break will be inserted ("before" or "after" the current drawing).

Returns

boolean

Try It

var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 3212465, 963295, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
oDrawing.InsertParagraph("Added a line break after this paragraph.", "before", false);
oDrawing.AddBreak(1, "before");

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).