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​

Read whether a specific range of characters has strikethrough formatting in a spreadsheet.

// How do I check if certain characters in a cell are displayed with a line through them in a spreadsheet?

// Inspect the strikethrough setting of a character range and display the result in a cell in a spreadsheet.

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);