SetUnderline
Specifies that the contents of the current run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line).
Syntax
expression.SetUnderline(isUnderline);
expression - A variable that represents a ApiRun class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| isUnderline | Required | boolean | Specifies that the contents of the current run are displayed underlined. |
Returns
Example
This example specifies that the contents of the current run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
- Code
- Result
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let run = Api.CreateRun();
run.AddText("This is just a sample text. ");
paragraph.AddElement(run);
run = Api.CreateRun();
run.SetUnderline(true);
run.AddText("This is a text run with the text underlined with a single line.");
paragraph.AddElement(run);