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

Direction

Enum Class Direction

java.lang.Object
java.lang.Enum<Direction>
com.grapecity.documents.excel.Direction
All Implemented Interfaces:
Serializable, Comparable<Direction>, Constable
public enum Direction extends Enum<Direction>
Specifies the direction in which to move.

This enum corresponds to Excel's xlDirection constants and is used to indicate a movement direction such as up, down, left, or right.


 Workbook workbook = new Workbook();
 IWorksheet worksheet = workbook.getActiveSheet();
 worksheet.getRange("A1").setValue("Start");

 Direction direction = Direction.forValue(-4121);
 String nextCell = direction == Direction.Down ? "A2" : "B1";
 worksheet.getRange(nextCell).setValue("Next");
 Object nextValue = worksheet.getRange("A2").getValue();

  • Enum Constant Details

    • Up

      public static final Direction Up
      Specifies the move direction is up.

    • ToRight

      public static final Direction ToRight
      Specifies the move direction is right.

    • ToLeft

      public static final Direction ToLeft
      Specifies the move direction is left.

    • Down

      public static final Direction Down
      Specifies the move direction is down.

  • Method Details

    • values

      public static Direction[] 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 Direction 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 Excel constant value for this direction.
      Returns:
      The Excel constant value.

    • forValue

      public static Direction forValue(int value)
      Gets the direction that corresponds to the specified Excel constant value.
      Parameters:
      value - The Excel constant value.
      Returns:
      The matching direction.