Skip to main content

Delete

Deletes the current format condition.

Inherited from ApiFormatCondition.Delete.

Syntax​

expression.Delete();

expression - A variable that represents an ApiUniqueValues class.

Parameters​

This method doesn't have any parameters.

Returns​

This method doesn't return any data.

Example​

Remove a conditional formatting rule that highlights unique values in a spreadsheet.

// How do I delete a unique-values highlighting rule from a cell range in a spreadsheet?

// Clear an unwanted unique-values rule so the range returns to its default appearance in a spreadsheet.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Data");
worksheet.GetRange("A2").SetValue("Apple");
worksheet.GetRange("A3").SetValue("Banana");
worksheet.GetRange("A4").SetValue("Apple");
worksheet.GetRange("A5").SetValue("Orange");

let range = worksheet.GetRange("A2:A5");
let formatConditions = range.GetFormatConditions();
let uniqueValuesCondition = formatConditions.AddUniqueValues();

let countBefore = formatConditions.GetCount();

uniqueValuesCondition.Delete();

let countAfter = formatConditions.GetCount();

worksheet.GetRange("C1").SetValue("Count before deletion:");
worksheet.GetRange("C2").SetValue(countBefore);
worksheet.GetRange("C3").SetValue("Count after deletion:");
worksheet.GetRange("C4").SetValue(countAfter);