SetSpacingBefore
Sets the spacing before the current paragraph.
If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
Inherited from ApiParaPr.SetSpacingBefore.
Syntax
expression.SetSpacingBefore(nBefore, isBeforeAuto);
expression - A variable that represents an ApiParagraph class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| nBefore | Required | twips | The value of the spacing before the current paragraph measured in twentieths of a point (1/1440 of an inch). | |
| isBeforeAuto | Optional | boolean | false | The true value disables the spacing before the current paragraph. |
Returns
boolean
Example
Add space above a paragraph in a PDF.
// How do I create gap before a paragraph in a PDF?
// Control the margin between an element and a paragraph in a PDF.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const gs1 = Api.CreateGradientStop(Api.RGB(255, 213, 191), 0);
const gs2 = Api.CreateGradientStop(Api.RGB(255, 111, 61), 100000);
const fill = Api.CreateRadialGradientFill([gs1, gs2]);
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
const docContent = shape.GetContent();
let paragraph = docContent.GetElement(0);
paragraph.AddText("This is an example of setting a space before a paragraph. ");
paragraph.AddText("The second paragraph will have an offset of one inch from the top. ");
paragraph.AddText("This is due to the fact that the second paragraph has this offset enabled.");
paragraph = Api.CreateParagraph();
paragraph.AddText("This is the second paragraph and it is one inch away from the first paragraph.");
paragraph.SetSpacingBefore(1440);
docContent.Push(paragraph);
page.AddObject(shape);