[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

SpecialCellType

Enum Class SpecialCellType

java.lang.Object
java.lang.Enum<SpecialCellType>
com.grapecity.documents.excel.SpecialCellType
All Implemented Interfaces:
Serializable, Comparable<SpecialCellType>, Constable
public enum SpecialCellType extends Enum<SpecialCellType>
Specifies the type of special cells to find within a range.

Used as a parameter for IRange.specialCells(com.grapecity.documents.excel.SpecialCellType) to locate cells matching specific criteria such as blanks, comments, constants, formulas, merged cells, and more.


 worksheet.getRange("A1").setValue("Hello");
 worksheet.getRange("A3").setValue(100);
 worksheet.getRange("B1:B3").setFormula("=A1");

 IRange blanks = worksheet.getRange("A1:A3").specialCells(SpecialCellType.Blanks);
 IRange formulas = worksheet.getRange("B1:B3").specialCells(SpecialCellType.Formulas);

  • Enum Constant Details

    • AllFormatConditions

      public static final SpecialCellType AllFormatConditions
      Cells of any format condition in the specified range.

    • AllValidation

      public static final SpecialCellType AllValidation
      Cells having validation criteria in the specified range.

    • Blanks

      public static final SpecialCellType Blanks
      Empty cells in the specified range.

    • Comments

      public static final SpecialCellType Comments
      Cells containing notes in the specified range.

    • Constants

      public static final SpecialCellType Constants
      Cells containing constants. Use the SpecialCellsValue enumeration to filter values by data types.

    • Formulas

      public static final SpecialCellType Formulas
      Cells containing formulas. Use the SpecialCellsValue enumeration to filter formulas by return types.

    • LastCell

      public static final SpecialCellType LastCell
      The last visible cell in the used range of the worksheet of the specified range.

    • SameFormatConditions

      public static final SpecialCellType SameFormatConditions
      Cells having the same format as the top-left cell of the specified range.

    • SameValidation

      public static final SpecialCellType SameValidation
      Cells having the same validation criteria as the top-left cell of the specified range.

    • Visible

      public static final SpecialCellType Visible
      All visible cells in the specified range.

    • MergedCells

      public static final SpecialCellType MergedCells
      Merged cells that intersect the specified range.

    • Tags

      public static final SpecialCellType Tags
      Cells containing tags in the specified range.

    • CellPicture

      public static final SpecialCellType CellPicture
      Cells containing picture-in-cell in the specified range.

  • Method Details

    • values

      public static SpecialCellType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SpecialCellType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Gets the ordinal value of this special cell type.
      Returns:
      The ordinal value.

    • forValue

      public static SpecialCellType forValue(int value)
      Gets the special cell type that corresponds to the specified ordinal value.
      Parameters:
      value - The ordinal value.
      Returns:
      The matching special cell type.