SetOutLine
Sets the text outline to the current text run.
Inherited from ApiTextPr.SetOutLine.
Syntax
expression.SetOutLine(oStroke);
expression - A variable that represents an ApiRun class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| oStroke | Required | ApiStroke | The stroke used to create the text outline. |
Returns
Example
Add an outline border to text in a PDF.
// How do I add a stroke effect to text in a PDF?
// Apply a border around text characters in a PDF.
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("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
let run = Api.CreateRun();
run.AddText("This is just a sample text. ");
paragraph.AddElement(run);
run = Api.CreateRun();
const runStroke = Api.CreateStroke(0.2 * 36000, Api.CreateSolidFill(Api.RGB(51, 51, 51)));
run.SetOutLine(runStroke);
run.AddText("This is a text run with the black text outline.");
paragraph.AddElement(run);
page.AddObject(shape);