GetNumberFormat

Returns the number format applied to a cell when the conditional formatting rule evaluates to true.

Inherited from ApiFormatCondition.GetNumberFormat.

Example

Read the number display pattern that a conditional formatting rule applies to matching cells in a spreadsheet.

// How do I find out what number format a conditional formatting rule uses for highlighted cells in a spreadsheet?

// Inspect the numeric display style of a formatting condition to confirm it presents values correctly in a spreadsheet.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Sales Data");
worksheet.GetRange("A2").SetValue(1234.56);
worksheet.GetRange("A3").SetValue(2500.75);
worksheet.GetRange("A4").SetValue(150.25);
worksheet.GetRange("A5").SetValue(3000.00);
worksheet.GetRange("A6").SetValue(750.50);

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

let formatConditions = dataRange.GetFormatConditions();

let condition1 = formatConditions.Add("xlCellValue", "xlGreater", "2000");
condition1.SetFillColor(Api.CreateColorFromRGB(255, 0, 0));
condition1.SetNumberFormat("$#,##0.00");

let numberFormat = condition1.GetNumberFormat();

worksheet.GetRange("C1").SetValue("Number format:");
worksheet.GetRange("C2").SetValue(numberFormat);