跳到主要内容

GetUnderline

Returns the type of underline applied to the specified font.

Syntax

expression.GetUnderline();

expression - A variable that represents a ApiFont class.

Parameters

This method doesn't have any parameters.

Returns

XlUnderlineStyle | null

Example

This example shows how to get the type of underline applied to the specified font.

let worksheet = Api.GetActiveSheet();
let range = worksheet.GetRange("B1");
range.SetValue("This is just a sample text.");
let characters = range.GetCharacters(9, 4);
let font = characters.GetFont();
font.SetUnderline("xlUnderlineStyleSingle");
let underlineType = font.GetUnderline();
worksheet.GetRange("B3").SetValue("Underline property: " + underlineType);