Skip to main content

SetStopIfTrue

Sets whether the editor will stop evaluating additional formatting rules if this rule evaluates to true.

Syntax​

expression.SetStopIfTrue(StopIfTrue);

expression - A variable that represents an ApiUniqueValues class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
StopIfTrueRequiredbooleanTrue to stop evaluating additional rules.

Returns​

This method doesn't return any data.

Example​

Stop the evaluation of the lower priority formatting rules when a unique values rule is fulfilled in a spreadsheet.

// How do I prevent the other formatting rules from being applied to the unique cells in a spreadsheet?

// Keep the unique cells formatted by the first rule only in a spreadsheet.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Sales Data");
worksheet.GetRange("A2").SetValue(100);
worksheet.GetRange("A3").SetValue(250);
worksheet.GetRange("A4").SetValue(150);
worksheet.GetRange("A5").SetValue(300);
worksheet.GetRange("A6").SetValue(75);

let dataRange = worksheet.GetRange("A2:A6");
let formatConditions = dataRange.GetFormatConditions();

let uniqueValues = formatConditions.AddUniqueValues();
let condition = formatConditions.Add("xlCellValue", "xlGreater", "20");

uniqueValues.SetFillColor(Api.RGB(255, 0, 0));
uniqueValues.SetStopIfTrue(true);

condition.SetNumberFormat("0.00");

worksheet.GetRange("C1").SetValue("The unique cells keep the general number format");