Package com.grapecity.documents.excel

Interface IWorksheetView

public interface IWorksheetView
Represents worksheet view options.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDisplayFormulas()
    Gets whether the worksheet displays formulas.
    boolean
    getDisplayGridlines()
    Gets whether gridlines are displayed.
    boolean
    getDisplayHeadings()
    Gets whether headers are displayed (True if both row and column headings are displayed; False if there are no headings displayed).
    boolean
    getDisplayHorizontalGridlines()
    Gets whether horizontal gridlines are displayed.
    boolean
    getDisplayOutline()
    Gets whether outline symbols are displayed.
    boolean
    getDisplayRightToLeft()
    Gets whether the specified worksheet is displayed from right to left instead of from left to right (False if the object is displayed from left to right).
    boolean
    getDisplayRuler()
    Gets whether a ruler is displayed for the specified worksheet.
    boolean
    getDisplayVerticalGridlines()
    Gets whether vertical gridlines are displayed.
    boolean
    getDisplayWhitespace()
    Gets whether whitespace is displayed.
    boolean
    getDisplayZeros()
    Gets whether zero values are displayed.
    Color
    getGridlineColor()
    Gets the Color object that represents the gridline color of the worksheet.
    int
    getScrollColumn()
    Gets the number of the leftmost column in the pane or worksheet.
    int
    getScrollRow()
    Gets the number of the row that appears at the top of the pane or worksheet.
    ViewType
    getViewType()
    Gets the view type.
    int
    getZoom()
    Gets a Variant value that represents the display size of the worksheet, as a percentage(100 equals normal size, 200 equals double size, and so on).
    void
    setDisplayFormulas(boolean value)
    Sets whether the worksheet displays formulas.
    void
    setDisplayGridlines(boolean value)
    Sets whether gridlines are displayed.
    void
    setDisplayHeadings(boolean value)
    Sets whether headers are displayed (True if both row and column headings are displayed; False if there are no headings displayed).
    void
    setDisplayHorizontalGridlines(boolean value)
    Sets whether horizontal gridlines are displayed.
    void
    setDisplayOutline(boolean value)
    Sets whether outline symbols are displayed.
    void
    setDisplayRightToLeft(boolean value)
    Sets whether the specified worksheet is displayed from right to left instead of from left to right (False if the object is displayed from left to right).
    void
    setDisplayRuler(boolean value)
    Sets whether a ruler is displayed for the specified worksheet.
    void
    setDisplayVerticalGridlines(boolean value)
    Sets whether vertical gridlines are displayed.
    void
    setDisplayWhitespace(boolean value)
    Sets whether whitespace is displayed.
    void
    setDisplayZeros(boolean value)
    Sets whether zero values are displayed.
    void
    setGridlineColor(Color value)
    Sets the Color object that represents the gridline color of the worksheet.
    void
    setScrollColumn(int value)
    Sets the number of the leftmost column in the pane or worksheet.
    void
    setScrollRow(int value)
    Sets the number of the row that appears at the top of the pane or worksheet.
    void
    setViewType(ViewType value)
    Sets the view type.
    void
    setZoom(int value)
    Sets a Variant value that represents the display size of the worksheet, as a percentage(100 equals normal size, 200 equals double size, and so on).

  • Method Details

    • getDisplayRightToLeft

      boolean getDisplayRightToLeft()
      Gets whether the specified worksheet is displayed from right to left instead of from left to right (False if the object is displayed from left to right).

    • setDisplayRightToLeft

      void setDisplayRightToLeft(boolean value)
      Sets whether the specified worksheet is displayed from right to left instead of from left to right (False if the object is displayed from left to right).

    • getDisplayFormulas

      boolean getDisplayFormulas()
      Gets whether the worksheet displays formulas. True if formulas are displayed; False if the worksheet displays values.

    • setDisplayFormulas

      void setDisplayFormulas(boolean value)
      Sets whether the worksheet displays formulas. True if formulas are displayed; False if the worksheet displays values.

    • getDisplayGridlines

      boolean getDisplayGridlines()
      Gets whether gridlines are displayed.

    • setDisplayGridlines

      void setDisplayGridlines(boolean value)
      Sets whether gridlines are displayed. When this is set, DisplayVerticalGridlines and DisplayHorizontalGridlines would be set to same value.

    • getDisplayVerticalGridlines

      boolean getDisplayVerticalGridlines()
      Gets whether vertical gridlines are displayed.

    • setDisplayVerticalGridlines

      void setDisplayVerticalGridlines(boolean value)
      Sets whether vertical gridlines are displayed. When this is set false, DisplayGridlines would be false, too.

    • getDisplayHorizontalGridlines

      boolean getDisplayHorizontalGridlines()
      Gets whether horizontal gridlines are displayed.

    • setDisplayHorizontalGridlines

      void setDisplayHorizontalGridlines(boolean value)
      Sets whether horizontal gridlines are displayed. When this is set false, DisplayGridlines would be false, too.

    • getDisplayHeadings

      boolean getDisplayHeadings()
      Gets whether headers are displayed (True if both row and column headings are displayed; False if there are no headings displayed).

    • setDisplayHeadings

      void setDisplayHeadings(boolean value)
      Sets whether headers are displayed (True if both row and column headings are displayed; False if there are no headings displayed).

    • getDisplayOutline

      boolean getDisplayOutline()
      Gets whether outline symbols are displayed.

    • setDisplayOutline

      void setDisplayOutline(boolean value)
      Sets whether outline symbols are displayed.

    • getDisplayRuler

      boolean getDisplayRuler()
      Gets whether a ruler is displayed for the specified worksheet.

    • setDisplayRuler

      void setDisplayRuler(boolean value)
      Sets whether a ruler is displayed for the specified worksheet.

    • getDisplayWhitespace

      boolean getDisplayWhitespace()
      Gets whether whitespace is displayed.

    • setDisplayWhitespace

      void setDisplayWhitespace(boolean value)
      Sets whether whitespace is displayed.

    • getDisplayZeros

      boolean getDisplayZeros()
      Gets whether zero values are displayed.

    • setDisplayZeros

      void setDisplayZeros(boolean value)
      Sets whether zero values are displayed.

    • getZoom

      int getZoom()
      Gets a Variant value that represents the display size of the worksheet, as a percentage(100 equals normal size, 200 equals double size, and so on).

    • setZoom

      void setZoom(int value)
      Sets a Variant value that represents the display size of the worksheet, as a percentage(100 equals normal size, 200 equals double size, and so on).

    • getViewType

      ViewType getViewType()
      Gets the view type.

    • setViewType

      void setViewType(ViewType value)
      Sets the view type.

    • getGridlineColor

      Color getGridlineColor()
      Gets the Color object that represents the gridline color of the worksheet.

    • setGridlineColor

      void setGridlineColor(Color value)
      Sets the Color object that represents the gridline color of the worksheet.

    • getScrollColumn

      int getScrollColumn()
      Gets the number of the leftmost column in the pane or worksheet.

    • setScrollColumn

      void setScrollColumn(int value)
      Sets the number of the leftmost column in the pane or worksheet.

    • getScrollRow

      int getScrollRow()
      Gets the number of the row that appears at the top of the pane or worksheet.

    • setScrollRow

      void setScrollRow(int value)
      Sets the number of the row that appears at the top of the pane or worksheet.