Skip to main content

SetSpacing

Sets the text spacing measured in twentieths of a point.

Syntax​

expression.SetSpacing(spacing);

expression - A variable that represents an ApiTextRange class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
spacingRequiredtwips | nullThe value of the text spacing measured in twentieths of a point (1/1440 of an inch). Pass null to remove the text spacing.

Returns​

ApiTextRange | null

Example​

Change the character spacing of a range in a shape on a PDF page.

// The spacing is measured in twentieths of a point.

// Spread the letters of the first word apart.

const doc = Api.GetDocument();
const page = doc.GetPage(0);

const fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("rect", 200 * 36000, 80 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
page.AddObject(shape);

const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
paragraph.AddText("Hello World");

const range = shape.GetTextRange();

range.GetRange(0, 5).SetSpacing(150);