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

SearchOrder

Enum Class SearchOrder

java.lang.Object
java.lang.Enum<SearchOrder>
com.grapecity.documents.excel.SearchOrder
All Implemented Interfaces:
Serializable, Comparable<SearchOrder>, Constable
public enum SearchOrder extends Enum<SearchOrder>
Specifies the order in which to search a range.

Use this enum with search-related APIs to control whether the search progresses row by row or column by column.


 worksheet.getRange("A1:C3").setValue(new Object[][] {
     {"Name", "Score", "City"},
     {"Alice", 100, "Paris"},
     {"Bob", 100, "Tokyo"}
 });
 FindOptions options = new FindOptions();
 options.setSearchOrder(SearchOrder.ByColumns);
 IRange found = worksheet.getRange("A1:C3").find(100, null, options);

  • Enum Constant Details

    • ByRows

      public static final SearchOrder ByRows
      Searches across a row, then moves to the next row.

    • ByColumns

      public static final SearchOrder ByColumns
      Searches down through a column, then moves to the next column.

  • Method Details

    • values

      public static SearchOrder[] 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 SearchOrder 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()

    • forValue

      public static SearchOrder forValue(int value)