Skip to main content

GetScopeType

Returns the scope type of the conditional formatting rule.

Inherited from ApiFormatCondition.GetScopeType.

Syntax​

expression.GetScopeType();

expression - A variable that represents an ApiTop10 class.

Parameters​

This method doesn't have any parameters.

Returns​

XlPivotConditionScope

Example​

Read the scope type of a top 10 conditional formatting rule in a spreadsheet.

// How do I find the scope setting of a top 10 conditional formatting rule in a spreadsheet?

// Determine how broadly a top 10 highlight rule applies across cells 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 condition1 = formatConditions.AddTop10();
condition1.SetFillColor(Api.CreateColorFromRGB(255, 255, 0));

let scopeType = condition1.GetScopeType();

worksheet.GetRange("C1").SetValue("Scope type:");
worksheet.GetRange("C2").SetValue(scopeType);