SetBetweenBorder

Specifies the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings.

Syntax

expression.SetBetweenBorder(sType, nSize, nSpace, r, g, b);

expression - A variable that represents a ApiParaPr class.

Parameters

Name	Required/Optional	Data type	Default	Description
sType	Required	BorderType		The border style.
nSize	Required	pt_8		The width of the current border measured in eighths of a point.
nSpace	Required	pt		The spacing offset between the paragraphs measured in points used to place this border.
r	Required	byte		Red color component value.
g	Required	byte		Green color component value.
b	Required	byte		Blue color component value.

Returns

boolean

Example

Add a border between consecutive same-styled paragraphs in a document.

// How do I draw a dividing line between paragraphs that share the same style in a document?

// Apply a uniform visual separator across a group of related paragraphs using a shared style.

let doc = Api.GetDocument();
let myStyle = doc.CreateStyle("My document style");
let paraPr = myStyle.GetParaPr();
paraPr.SetBetweenBorder("single", 24, 0, 255, 111, 61);
let paragraph = doc.GetElement(0);
paragraph.SetStyle(myStyle);
paragraph.AddText("This is the first paragraph. ");
paragraph.AddText("The paragraph properties styled above set a border between paragraphs.");
paragraph = Api.CreateParagraph();
paragraph.SetStyle(myStyle);
paragraph.AddText("This is the second paragraph. ");
paragraph.AddText("No need to add anything additionally to it. ");
paragraph.AddText("The borders between the paragraphs have already been set.");
doc.Push(paragraph);
paragraph = Api.CreateParagraph();
paragraph.SetStyle(myStyle);
paragraph.AddText("This is the third paragraph. ");
paragraph.AddText("No need to add anything additionally to it. ");
paragraph.AddText("The borders between the paragraphs have already been set.");
doc.Push(paragraph);