[]
        
(Showing Draft Content)

IIconCriteria

Interface IIconCriteria


public interface IIconCriteria
Represents the collection of IIconCriterion objects.

Each IIconCriterion represents the values and threshold type for an icon in an icon set conditional formatting rule.


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
 IIconCriteria criteria = condition.getIconCriteria();
 
  • Method Summary

    Modifier and Type
    Method
    Description
    get(int Index)
    Returns an IIconCriterion object from the collection.
    int
    Gets the number of criteria in the icon set conditional formatting rule.
  • Method Details

    • getCount

      int getCount()
      Gets the number of criteria in the icon set conditional formatting rule.

      This value indicates how many IIconCriterion objects are available in the IIconCriteria collection for the current icon set conditional formatting rule.

      
       worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
       IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
       condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
       int count = condition.getIconCriteria().getCount();
       
      Returns:
      The number of criteria in the icon set conditional formatting rule.
    • get

      IIconCriterion get(int Index)
      Returns an IIconCriterion object from the collection.

      Each returned criterion represents the threshold settings for one icon in an icon set conditional formatting rule.

      
       worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
       IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
       condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
       IIconCriterion criterion = condition.getIconCriteria().get(1);
       
      Parameters:
      Index - The zero-based index of the icon criterion. The valid range is 0 through getCount() - 1. An index outside this range is invalid and causes an IndexOutOfBoundsException when the criterion is accessed.
      Returns:
      The IIconCriterion object at the specified index.