SetStrikeout
Specifies that the contents of the run are displayed with a single horizontal line through the center of the line.
Syntax
expression.SetStrikeout(isStrikeout);
expression - A variable that represents a ApiTextPr class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| isStrikeout | Required | boolean | Specifies that the contents of the current run are displayed struck through. |
Returns
Example
This example specifies that the contents of the run are displayed with a single horizontal line through the center of the line.
- Code
- Result
// How to strike out a text with one line.
// Get the text properties of the run and cross it out.
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.GetDocContent();
const paragraph = docContent.GetElement(0);
const run = Api.CreateRun();
const textPr = run.GetTextPr();
textPr.SetFontSize(50);
textPr.SetStrikeout(true);
paragraph.SetJc("left");
run.AddText("This is a struck out text inside the shape.");
paragraph.AddElement(run);
page.AddObject(shape);