TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

SetTopBorder

SetTopBorder(sType, nSize, nSpace, r, g, b)

Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings. 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.

Parameters:

Name Type Description
sType BorderType

The border style.

nSize pt_8

The width of the current top border measured in eighths of a point.

nSpace pt

The spacing offset above the paragraph measured in points used to place this border.

r byte

Red color component value.

g byte

Green color component value.

b byte

Blue color component value.

Returns:

This method doesn't return any data.

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oMyStyle = oDocument.CreateStyle("My document style");
var oParaPr = oMyStyle.GetParaPr();
oParaPr.SetTopBorder("single", 24, 0, 255, 111, 61);
var oParagraph = oDocument.GetElement(0);
oParagraph.SetStyle(oMyStyle);
oParagraph.AddText("This is the first paragraph. ");
oParagraph.AddText("The paragraph properties styled above set a border above it.");
builder.SaveFile("docx", "SetTopBorder.docx");
builder.CloseFile();

Resulting document