Skip to main content

SetBottomBorder

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

note

The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block.

Inherited from ApiParaPr.SetBottomBorder.

Syntax​

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

expression - A variable that represents an ApiParagraph class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
sTypeRequiredBorderTypeThe border style.
nSizeRequiredpt_8The width of the current bottom border measured in eighths of a point.
nSpaceRequiredptThe spacing offset below 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​

Draw a border below a paragraph in a document.

// How do I add a bottom border line to a paragraph in a document?

// Visually separate a paragraph from the content beneath it using a styled bottom border in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("This is the first paragraph. We will add a thin orange border below it.");
paragraph.SetBottomBorder("single", 8, 0, 255, 111, 61);