SetLeftBorder
Specifies the border which will be displayed at the left side of the page around the specified paragraph.
Inherited from ApiParaPr.SetLeftBorder.
Syntax
expression.SetLeftBorder(sType, nSize, nSpace, r, g, b);
expression - A variable that represents an ApiParagraph class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| sType | Required | BorderType | The border style. | |
| nSize | Required | pt_8 | The width of the current left border measured in eighths of a point. | |
| nSpace | Required | pt | The spacing offset to the left 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 colored border along the left edge of a paragraph in a document.
// How do I draw a vertical line on the left side of a paragraph in a document?
// Highlight a paragraph by placing a styled border on its left side in a document.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("This is the first paragraph. We will add a two point orange border at its left side. ");
paragraph.AddText("The space between the left side of the paragraph and the border is 8 points. ");
paragraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
paragraph.AddText("These sentences are used to add lines for demonstrative purposes.");
paragraph.SetLeftBorder("single", 16, 8, 255, 111, 61);