Conditional Formatting
| API | Description | Example |
|---|---|---|
| Range.FormatConditions | Property that returns the conditional formatting management object for the specified range | let range = instance.Application.ActiveSheet.Range("A1"); let formatConditions = range.FormatConditions; |
| FormatConditions.Count | Property that returns the number of conditional formatting rules | let range = instance.Application.ActiveSheet.Range("A1"); let formatConditions = range.FormatConditions; console.log(formatConditions.Count); |
| FormatConditions.Add | Function that adds conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.Add({ Type: instance.Enums.XlFormatConditionType.xlCellValue, Operator: instance.Enums.XlFormatConditionOperator.xlGreater, Formula1: "=10" }); |
| FormatConditions.AddAboveAverage | Function that adds above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.AddAboveAverage(); |
| AboveAverage.AboveBelow | Property that returns or changes the condition to specify based on average | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); console.log(aboveAverage.AboveBelow); aboveAverage.AboveBelow = instance.Enums.XlAboveBelow.xlAboveAverage; |
| AboveAverage.AppliesTo | Property that returns the target range object of the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); let target = aboveAverage.AppliesTo; |
| AboveAverage.Borders | Property that returns the border management object for the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); let borders = aboveAverage.Borders; |
| AboveAverage.Font | Property that returns the font management object for the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); let font = aboveAverage.Font; |
| AboveAverage.Interior | Property that returns the background color management object for the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); let interior = aboveAverage.Interior; |
| AboveAverage.Priority | Property that returns or changes the priority of the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); console.log(aboveAverage.Priority); aboveAverage.Priority = 1; |
| AboveAverage.StopIfTrue | Property that returns or changes whether to continue evaluating additional conditional formatting when the above average conditional formatting meets the condition | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); console.log(aboveAverage.StopIfTrue); aboveAverage.StopIfTrue = true; |
| AboveAverage.Type | Property that returns the type of the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); console.log(aboveAverage.Type); // 12 corresponding to instance.Enums.XlFormatConditionType.xlAboveAverageCondition is output to console |
| AboveAverage.Delete | Function that removes the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); aboveAverage.Delete(); |
| AboveAverage.ModifyAppliesToRange | Function that changes the target range of the above average conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); let target = instance.Application.ActiveSheet.Range("B2"); aboveAverage.ModifyAppliesToRange(target); |
| AboveAverage.SetFirstPriority | Function that changes the priority to highest so that the above average conditional formatting is evaluated before other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); aboveAverage.SetFirstPriority(); |
| AboveAverage.SetLastPriority | Function that changes the priority to lowest so that the above average conditional formatting is evaluated after all other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let aboveAverage = range.FormatConditions.AddAboveAverage(); aboveAverage.SetLastPriority(); |
| FormatConditions.AddColorScale | Function that adds color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.AddColorScale(1); |
| ColorScale.AppliesTo | Property that returns the target range object of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let target = colorScale.AppliesTo; |
| ColorScale.ColorScaleCriteria | Property that returns the object that manages the criteria of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriteria = colorScale.ColorScaleCriteria; |
| ColorScaleCriteria.Count | Property that returns the number of criteria for the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriteria = colorScale.ColorScaleCriteria; console.log(colorScaleCriteria.Count); |
| ColorScaleCriteria.Item | Function that returns the criteria object corresponding to a specific index of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriteria = colorScale.ColorScaleCriteria; let colorScaleCriterion = colorScaleCriteria.Item(1); |
| ColorScaleCriterion.FormatColor | Property that returns the object that manages the criteria color corresponding to a specific index of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); let formatColor = colorScaleCriterion.FormatColor; |
| FormatColor.Color | Property that returns or changes the criteria color corresponding to a specific index of the conditional formatting cf) RGB numeric values corresponding to colors must be used | function RGBToInteger(rgbText) { const [r,g,b] = rgbText.match(/\d+/g).map(Number); return r + g * 256 + b * 65536; } let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); let formatColor = colorScaleCriterion.FormatColor; console.log(formatColor.Color); formatColor.Color = RGBToInteger("RGB(255,199,206)"); |
| FormatColor.ColorIndex | Property that returns or changes the criteria color corresponding to a specific index of the conditional formatting using index method | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); let formatColor = colorScaleCriterion.FormatColor; console.log(formatColor.ColorIndex); formatColor.ColorIndex = 1; |
| FormatColor.ThemeColor | Property that returns or changes the criteria theme color corresponding to a specific index of the conditional formatting using index method | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); let formatColor = colorScaleCriterion.FormatColor; console.log(formatColor.ThemeColor); formatColor.ThemeColor = 1; |
| FormatColor.TintAndShade | Property that returns or changes the criteria brightness corresponding to a specific index of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); let formatColor = colorScaleCriterion.FormatColor; console.log(formatColor.TintAndShade); formatColor.TintAndShade = 0.3; |
| ColorScaleCriterion.Index | Property that returns the index of the criteria corresponding to a specific index of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); console.log(colorScaleCriterion.Index); |
| ColorScaleCriterion.Type | Property that returns or changes the type of the criteria corresponding to a specific index of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); console.log(colorScaleCriterion.Type); colorScaleCriterion.Type = instance.Enums.XlConditionValueTypes.xlConditionValueHighestValue; |
| ColorScaleCriterion.Value | Property that returns or changes the criteria value corresponding to a specific index of the color scale conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); let colorScaleCriterion = colorScale.ColorScaleCriteria.Item(1); console.log(colorScaleCriterion.Value); colorScaleCriterion.Value = 5; |
| ColorScale.SetLastPriority | Function that changes the priority to lowest so that the color scale conditional formatting is evaluated last | let range = instance.Application.ActiveSheet.Range("A1:B2"); let colorScale = range.FormatConditions.AddColorScale(1); colorScale.SetLastPriority(); |
| FormatConditions.AddDatabar | Function that adds data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.AddDatabar(); |
| Databar.AppliesTo | Property that returns the target range object of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let target = databar.AppliesTo; |
| Databar.AxisColor | Property that returns the object that manages the axis color of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let formatColor = databar.AxisColor; |
| Databar.AxisPosition | Property that returns or changes the axis position of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); console.log(databar.AxisPosition); databar.AxisPosition = instance.Enums.XlDataBarAxisPosition.xlDataBarAxisAutomatic; |
| Databar.BarColor | Property that returns the object that manages the bar color of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let formatColor = databar.BarColor; |
| Databar.BarFillType | Property that returns or changes the bar background fill method of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); console.log(databar.BarFillType); databar.BarFillType = instance.Enums.XlDataBarFillType.xlDataBarFillSolid; |
| Databar.MaxPoint | Property that returns the object that manages the longest bar of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let conditionValue = databar.MaxPoint; |
| ConditionValue.Type | Property that returns the condition type of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let conditionValue = databar.MaxPoint; console.log(conditionValue.Type); |
| ConditionValue.Value | Property that returns the condition value of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let conditionValue = databar.MaxPoint; console.log(conditionValue.Value); |
| ConditionValue.Modify | Function that modifies the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let conditionValue = databar.MaxPoint; conditionValue.Modify(instance.Enums.XlConditionValueTypes.xlConditionValuePercent, 30); |
| Databar.MinPoint | Property that returns the object that manages the shortest bar of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let conditionValue = databar.MinPoint; |
| Databar.Priority | Property that returns or changes the priority of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); console.log(databar.Priority); databar.Priority = 1; |
| Databar.StopIfTrue | Property that returns or changes whether to continue evaluating additional conditional formatting when the data bar conditional formatting meets the condition | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); console.log(databar.StopIfTrue); databar.StopIfTrue = true; |
| Databar.Type | Property that returns the type of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); console.log(colorScale.Type); // 4 corresponding to instance.Enums.XlFormatConditionType.xlDatabar is output to console |
| Databar.Delete | Function that removes the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); databar.Delete(); |
| Databar.ModifyAppliesToRange | Function that changes the target range of the data bar conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); let target = instance.Application.ActiveSheet.Range("B2"); databar.ModifyAppliesToRange(target); |
| Databar.SetFirstPriority | Function that changes the priority to highest so that the data bar conditional formatting is evaluated before other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); databar.SetFirstPriority(); |
| Databar.SetLastPriority | Function that changes the priority to lowest so that the data bar conditional formatting is evaluated after all other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let databar = range.FormatConditions.AddDatabar(); databar.SetLastPriority(); |
| FormatConditions.AddIconSetCondition | Function that adds icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.AddIconSetCondition(); |
| IconSetCondition.AppliesTo | Property that returns the target range object of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let target = iconSetCondition.AppliesTo; |
| IconSetCondition.IconCriteria | Property that returns the object that manages the criteria of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriteria = iconSetCondition.IconCriteria; |
| IconCriteria.Count | Property that returns the number of criteria for the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriteria = iconSetCondition.IconCriteria; console.log(iconCriteria.Count); |
| IconCriteria.Item | Function that returns the criteria object corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriteria = iconSetCondition.IconCriteria; let iconCriterion = iconCriteria.Item(1); |
| IconCriterion.Icon | Property that returns or changes the icon of the criteria corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriterion = iconSetCondition.IconCriteria.Item(1); console.log(iconCriterion.Icon); iconCriterion.Icon = instance.Enums.XlIcon.xlIconGreenUpArrow; |
| IconCriterion.Index | Property that returns the index of the criteria corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriterion = iconSetCondition.IconCriteria.Item(1); console.log(iconCriterion.Index); |
| IconCriterion.Operator | Property that returns or changes the operation method of the criteria corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriterion = iconSetCondition.IconCriteria.Item(1); console.log(iconCriterion.Operator); iconCriterion.Operator = instance.Enums.XlFormatConditionOperator.xlGreater; |
| IconCriterion.Type | Property that returns or changes the type of the criteria corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriterion = iconSetCondition.IconCriteria.Item(1); console.log(iconCriterion.Type); iconCriterion.Type = instance.Enums.XlConditionValueTypes.xlConditionValueNumber; |
| IconCriterion.Value | Property that returns or changes the condition value of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconCriterion = iconSetCondition.IconCriteria.Item(1); console.log(iconCriterion.Value); iconCriterion.Value = 5; |
| IconSetCondition.IconSet | Property that returns the object that manages the icon set of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconSet = iconSetCondition.IconSet; |
| IconSet.Count | Property that returns the number of icons in the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconSet = iconSetCondition.IconSet; console.log(iconSet.Count); |
| IconSet.ID | Property that returns the icon type used in the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconSet = iconSetCondition.IconSet; console.log(iconSet.ID); |
| IconSet.Item | Function that returns the icon object corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconSet = iconSetCondition.IconSet; let icon = iconSet.Item(1); |
| Icon.Index | Property that returns the index of the icon corresponding to a specific index of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let iconSet = iconSetCondition.IconSet; let icon = iconSet.Item(1); console.log(icon.Index); |
| IconSetCondition.PercentileValues | Property that returns or changes whether the icon set conditional formatting follows percentile values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); console.log(iconSetCondition.PercentileValues); iconSetCondition.PercentileValues = true; |
| IconSetCondition.Priority | Property that returns or changes the priority of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); console.log(iconSetCondition.Priority); iconSetCondition.Priority = 1; |
| IconSetCondition.ReverseOrder | Property that returns or changes whether the icon order of the icon set conditional formatting is reversed | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); console.log(iconSetCondition.ReverseOrder); iconSetCondition.ReverseOrder = true; |
| IconSetCondition.ShowIconOnly | Property that returns or changes whether to show only icons in the range where the icon set conditional formatting is applied | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); console.log(iconSetCondition.ShowIconOnly); iconSetCondition.ShowIconOnly = true; |
| IconSetCondition.StopIfTrue | Property that returns or changes whether to continue evaluating additional conditional formatting when the icon set conditional formatting meets the condition | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); console.log(iconSetCondition.StopIfTrue); iconSetCondition.StopIfTrue = true; |
| IconSetCondition.Type | Property that returns the type of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); console.log(iconSetCondition.Type); // 6 corresponding to instance.Enums.XlFormatConditionType.xlIconSets is output to console |
| IconSetCondition.Delete | Function that removes the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); iconSetCondition.Delete(); |
| IconSetCondition.ModifyAppliesToRange | Function that changes the target range of the icon set conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); let target = instance.Application.ActiveSheet.Range("B2"); iconSetCondition.ModifyAppliesToRange(target); |
| IconSetCondition.SetFirstPriority | Function that changes the priority to highest so that the icon set conditional formatting is evaluated before other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); iconSetCondition.SetFirstPriority(); |
| IconSetCondition.SetLastPriority | Function that changes the priority to lowest so that the icon set conditional formatting is evaluated after all other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let iconSetCondition = range.FormatConditions.AddIconSetCondition(); iconSetCondition.SetLastPriority(); |
| FormatConditions.AddTop10 | Function that adds top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.AddTop10(); |
| Top10.AppliesTo | Property that returns the target range object of the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); let target = top10.AppliesTo; |
| Top10.Borders | Property that returns the border management object for the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); let border = top10.Borders; |
| Top10.Font | Property that returns the font management object for the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); let font = top10.Font; |
| Top10.Interior | Property that returns the background color management object for the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); let interior = top10.Interior; |
| Top10.Percent | Property that returns or changes whether to set the ranking of the top 10 items conditional formatting based on percentage values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); console.log(top10.Percent); top10.Percent = true; |
| Top10.Priority | Property that returns or changes the priority of the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); console.log(top10.Priority); top10.Priority = 1; |
| Top10.Rank | Property that returns or changes the criteria value for ranking the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); console.log(top10.Rank); top10.Rank = 5; |
| Top10.StopIfTrue | Property that returns or changes whether to continue evaluating additional conditional formatting when the top 10 items conditional formatting meets the condition | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); console.log(top10.StopIfTrue); top10.StopIfTrue = true; |
| Top10.TopBottom | Property that returns or changes whether the top 10 items conditional formatting applies to top items or bottom items | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); console.log(top10.TopBottom); top10.TopBottom = instance.Enums.XlTopBottom.xlTop10Top; |
| Top10.Type | Property that returns the type of the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); console.log(top10.Type); // 5 corresponding to instance.Enums.XlFormatConditionType.xlTop10 is output to console |
| Top10.Delete | Function that removes the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); top10.Delete(); |
| Top10.ModifyAppliesToRange | Function that changes the target range of the top 10 items conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); let target = instance.Application.ActiveSheet.Range("B2"); top10.ModifyAppliesToRange(target); |
| Top10.SetFirstPriority | Function that changes the priority to highest so that the top 10 items conditional formatting is evaluated before other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); top10.SetFirstPriority(); |
| Top10.SetLastPriority | Function that changes the priority to lowest so that the top 10 items conditional formatting is evaluated after all other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let top10 = range.FormatConditions.AddTop10(); top10.SetLastPriority(); |
| FormatConditions.AddUniqueValues | Function that adds conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.AddUniqueValues(); |
| UniqueValues.AppliesTo | Property that returns the target range object of the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); let target = uniqueValues.AppliesTo; |
| UniqueValues.Borders | Property that returns the border management object for the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); let borders = uniqueValues.Borders; |
| UniqueValues.DupeUnique | Property that returns or changes whether the criteria of the conditional formatting based on unique values is for unique values or duplicate values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); console.log(uniqueValues.DupeUnique); uniqueValues.DupeUnique = instance.Enums.XlDupeUnique.xlDuplicate; |
| UniqueValues.Font | Property that returns the font management object for the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); let font = uniqueValues.Font; |
| UniqueValues.Interior | Property that returns the background color management object for the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); let interior = uniqueValues.Font; |
| UniqueValues.Priority | Property that returns or changes the priority of the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); console.log(uniqueValues.Priority); uniqueValues.Priority = 1; |
| UniqueValues.StopIfTrue | Property that returns or changes whether to continue evaluating additional conditional formatting when the conditional formatting based on unique values meets the condition | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); console.log(uniqueValues.StopIfTrue); uniqueValues.StopIfTrue = true; |
| UniqueValues.Type | Property that returns the type of the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); console.log(uniqueValues.Type); // 8 corresponding to instance.Enums.XlFormatConditionType.xlUniqueValues is output to console |
| UniqueValues.Delete | Function that removes the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); uniqueValues.Delete(); |
| UniqueValues.ModifyAppliesToRange | Function that changes the target range of the conditional formatting based on unique values | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); let target = instance.Application.ActiveSheet.Range("B2"); uniqueValues.ModifyAppliesToRange(target); |
| UniqueValues.SetFirstPriority | Function that changes the priority to highest so that the conditional formatting based on unique values is evaluated before other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); uniqueValues.SetFirstPriority(); |
| UniqueValues.SetLastPriority | Function that changes the priority to lowest so that the conditional formatting based on unique values is evaluated after all other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let uniqueValues = range.FormatConditions.AddUniqueValues(); uniqueValues.SetLastPriority(); |
| FormatConditions.Delete | Function that removes all conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; formatConditions.Delete(); |
| FormatConditions.Item | Function that returns the conditional formatting object at a specific index | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); |
| FormatCondition.AppliesTo | Property that returns the target range object of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); let target = formatCondition.AppliesTo; |
| FormatCondition.Borders | Property that returns the border object of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); let borders = formatCondition.Borders; |
| FormatCondition.DateOperator | Property that returns or changes the date operation method of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.DateOperator); formatCondition.DateOperator = instance.Enums.XlTimePeriods.xlToday; |
| FormatCondition.Font | Property that returns the font object of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); let font = formatCondition.Font; |
| FormatCondition.Formula1 | Property that returns the first formula used for evaluating the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.Formula1); |
| FormatCondition.Formula2 | Property that returns the second formula used for evaluating the conditional formatting cf) Works normally when the operation method of the conditional formatting (FormatCondition.Operator) corresponds to the following items · instance.Enums.XlFormatConditionOperator.xlBetween · instance.Enums.XlFormatConditionOperator.xlNotBetween | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.Formula2); |
| FormatCondition.Interior | Property that returns the range background object of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); let interior = formatCondition.Interior; |
| FormatCondition.NumberFormat | Property that returns or changes the display format specified for the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.NumberFormat); formatCondition.NumberFormat = "General"; |
| FormatCondition.Operator | Property that returns the operation method of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.Operator); |
| FormatCondition.Priority | Property that returns or changes the priority of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.Priority); formatCondition.Priority = 1; |
| FormatCondition.StopIfTrue | Property that returns or changes whether to continue evaluating additional conditional formatting when the conditional formatting meets the condition | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.StopIfTrue); formatCondition.StopIfTrue = true; |
| FormatCondition.Text | Property that returns or changes the string used in the condition of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.Text); formatCondition.Text = "10"; |
| FormatCondition.TextOperator | Property that returns or changes how the condition of the conditional formatting operates on strings | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.TextOperator); formatCondition.TextOperator = instance.Enums.XlContainsOperator.xlDoesNotContain; |
| FormatCondition.Type | Property that returns the type of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); console.log(formatCondition.Type); |
| FormatCondition.Delete | Function that removes the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); formatCondition.Delete(); |
| FormatCondition.Modify | Function that modifies the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); formatCondition.Modify(instance.Enums.XlFormatConditionType.xlCellValue); |
| FormatCondition.ModifyAppliesToRange | Function that changes the target range of the conditional formatting | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); let target = instance.Application.ActiveSheet.Range("B2"); formatCondition.ModifyAppliesToRange(target); |
| FormatCondition.SetFirstPriority | Function that changes the priority to highest so that the conditional formatting is evaluated before other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); formatCondition.SetFirstPriority(); |
| FormatCondition.SetLastPriority | Function that changes the priority to lowest so that the conditional formatting is evaluated after all other conditions | let range = instance.Application.ActiveSheet.Range("A1:B2"); let formatConditions = range.FormatConditions; let formatCondition = formatConditions.Item(1); formatCondition.SetLastPriority(); |
Related Features
Format Management , Font Style , Cell Background Color and Border , Text Alignment and Line Breaks , Custom Formatting , Format Rendering Overview