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

PrintLocation

Enum Class PrintLocation

java.lang.Object
java.lang.Enum<PrintLocation>
com.grapecity.documents.excel.PrintLocation
All Implemented Interfaces:
Serializable, Comparable<PrintLocation>, Constable
public enum PrintLocation extends Enum<PrintLocation>
Represents the way comments are printed with the sheet.

Use this enum with IPageSetup.setPrintComments(PrintLocation) to control whether worksheet comments are omitted from printed output, printed as end notes, or printed in their original positions.


 worksheet.getRange("A1").addComment("Review this value.");
 worksheet.getPageSetup().setPrintComments(PrintLocation.SheetEnd);
 PrintLocation printLocation = worksheet.getPageSetup().getPrintComments();

  • Enum Constant Details

    • NoComments

      public static final PrintLocation NoComments
      Comments will not be printed.

    • SheetEnd

      public static final PrintLocation SheetEnd
      Comments will be printed as end notes at the end of the worksheet.

    • InPlace

      public static final PrintLocation InPlace
      Comments will be printed where they were inserted on the worksheet.

  • Method Details

    • values

      public static PrintLocation[] 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 PrintLocation 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 integer value of this enum member.
      Returns:
      The zero-based integer value of this enum member.

    • forValue

      public static PrintLocation forValue(int value)
      Gets the enum member for the specified integer value.
      Parameters:
      value - The zero-based integer value.
      Returns:
      The matching PrintLocation member.