Skip to main content

SetLeftBorder

Specifies the border which will be displayed at the left side of the page around the specified paragraph.

Syntax

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

expression - A variable that represents a ApiParagraph class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTypeRequiredBorderTypeThe border style.
nSizeRequiredpt_8The width of the current left border measured in eighths of a point.
nSpaceRequiredptThe spacing offset to the left of the paragraph measured in points used to place this border.
rRequiredbyteRed color component value.
gRequiredbyteGreen color component value.
bRequiredbyteBlue color component value.

Returns

boolean

Example

This example specifies the border which will be displayed at the left side of the page around the specified paragraph.

// How to add border to the left side of the paragraph.

// Add left single border.

let doc = Api.GetDocument();
let myStyle = doc.CreateStyle("My document style");
let paraPr = myStyle.GetParaPr();
paraPr.SetLeftBorder("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 at its left side.");