Skip to main content

SetStrikethrough

Sets the strikethrough property to the specified font.
💡 This method will work only with the text format of the cell.

Syntax

expression.SetStrikethrough(isStrikethrough);

expression - A variable that represents a ApiFont class.

Parameters

NameRequired/OptionalData typeDefaultDescription
isStrikethroughRequiredbooleanSpecifies that the text characters are displayed strikethrough.

Returns

This method doesn't return any data.

Example

This example sets the strikethrough property 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.SetStrikethrough(true);