SetUnderline
Specifies that the contents of the current Range 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 an ApiTextRange class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| isUnderline | Required | boolean | null | Specifies if the contents of the current Range are displayed underlined or not. Pass null to remove the underline. |
Returns
Example
Underline the text of a range in a shape on a worksheet.
// The formatting applies to the covered fragment only.
// Underline the first word.
let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = worksheet.AddShape("rect", 200 * 36000, 80 * 36000, fill, stroke, 3, 0, 1, 0);
let docContent = shape.GetContent();
let paragraph = docContent.GetElement(0);
paragraph.AddText("Hello World");
let range = shape.GetTextRange();
range.GetRange(0, 5).SetUnderline(true);