Skip to main content

GetStrikethrough

Returns the strikethrough property of the specified font.

Syntax​

expression.GetStrikethrough();

expression - A variable that represents a ApiFont class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean | null

Example​

This example shows how to get the strikethrough property of 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.SetStrikethrough(true);
let isStrikethrough = font.GetStrikethrough();
worksheet.GetRange("B3").SetValue("Strikethrough property: " + isStrikethrough);