SetRightBorder
Specifies the border which will be displayed at the right side of the page around the specified paragraph.
Syntax
expression.SetRightBorder(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 right border measured in eighths of a point. | |
| nSpace | Required | pt | The spacing offset to the right of the paragraph 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 to the right side of a paragraph in a document.
// How do I place a visible border on the right edge of a paragraph in a document?
// Highlight a paragraph by drawing a colored line along its right margin.
let doc = Api.GetDocument();
let myStyle = doc.CreateStyle("My document style");
let paraPr = myStyle.GetParaPr();
paraPr.SetRightBorder("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 right side.");