com.groupdocs.viewer.options

Method Detail

• forOnePagePerSheet

  public static SpreadsheetOptions forOnePagePerSheet()

  Initializes new instance of SpreadsheetOptions class for rendering whole sheet into page.

  Returns:

  New instance of SpreadsheetOptions class for rendering one sheet into one page.

• forRenderingByPageBreaks

  public static SpreadsheetOptions forRenderingByPageBreaks()

  Initializes new instance of for rendering print areas only.

  Returns:

  New instance of SpreadsheetOptions for rendering by page breaks. The behaviour similar to printing in Excel.

• forRenderingPrintArea

  public static SpreadsheetOptions forRenderingPrintArea()

  Initializes new instance of SpreadsheetOptions for rendering print areas only.

  Returns:

  New instance of SpreadsheetOptions for rendering print areas only.

• forSplitSheetIntoPages

  public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage)
                                                   throws IllegalArgumentException

  Initializes new instance of SpreadsheetOptions for rendering sheet into pages.

  Parameters:

  countRowsPerPage - Rows count to include into each page.

  Returns:

  New instance of SpreadsheetOptions for rendering sheet into pages.

  Throws:

  IllegalArgumentException - Thrown when countRowsPerPage is equals or less than zero.

• forSplitSheetIntoPages

  public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage,
                                                          int countColumnsPerPage)

  Initializes new instance of for rendering sheet into pages.

  Parameters:

  countRowsPerPage - Rows count to include into each page.

  countColumnsPerPage - Columns count to include into each page.

  Returns:

  New instance of for rendering sheet into pages.

• getCountColumnsPerPage

  public int getCountColumnsPerPage()

  The columns count to include into each page when splitting worksheet into pages.

• getCountRowsPerPage

  public final int getCountRowsPerPage()

  The rows count to include into each page when splitting worksheet into pages.

• getTextOverflowMode

  public final TextOverflowMode getTextOverflowMode()

  The text overflow mode for rendering spreadsheet documents into HTML.

  Returns:

  The text overflow mode for rendering spreadsheet documents into HTML.

• isDetectSeparator

  public boolean isDetectSeparator()

  Detect separator (for CSV/TSV files).

• isOnePagePerSheet

  public final boolean isOnePagePerSheet()

  Indicates that one sheet is rendered into one page.

• isRenderByPageBreaks

  public boolean isRenderByPageBreaks()

  When this option is enabled a worksheet will be rendered by page breaks. The behaviour is the same as you're printing a spreadsheet in Excel.

• isRenderGridLines

  public final boolean isRenderGridLines()

  Enables grid lines rendering.

• isRenderHeadings

  public boolean isRenderHeadings()

  Is headings rendering enabled.

  Returns:

  headings rendering enabled.

• isRenderHiddenColumns

  public final boolean isRenderHiddenColumns()

  Enables hidden columns rendering.

• isRenderHiddenRows

  public final boolean isRenderHiddenRows()

  Enables hidden rows rendering.

• isRenderPrintAreaOnly

  public final boolean isRenderPrintAreaOnly()

  Indicates that only print areas are rendered.

• isSkipEmptyColumns

  public final boolean isSkipEmptyColumns()

  Disables empty columns rendering.

• isSkipEmptyRows

  public final boolean isSkipEmptyRows()

  Disables empty rows rendering.

• setCountColumnsPerPage

  public void setCountColumnsPerPage(int countColumnsPerPage)

  The columns count to include into each page when splitting worksheet into pages.

• setDetectSeparator

  public void setDetectSeparator(boolean detectSeparator)

  Detect separator (for CSV/TSV files).

• setRenderByPageBreaks

  public void setRenderByPageBreaks(boolean renderByPageBreaks)

  When this option is enabled a worksheet will be rendered by page breaks. The behaviour is the same as you're printing a spreadsheet in Excel.

• setRenderGridLines

  public final void setRenderGridLines(boolean value)

  Enables grid lines rendering.

• setRenderHeadings

  public void setRenderHeadings(boolean mRenderHeadings)

  Enables headings rendering.

• setRenderHiddenColumns

  public final void setRenderHiddenColumns(boolean value)

  Enables hidden columns rendering.

• setRenderHiddenRows

  public final void setRenderHiddenRows(boolean value)

  Enables hidden rows rendering.

• setSkipEmptyColumns

  public final void setSkipEmptyColumns(boolean value)

  Disables empty columns rendering.

• setSkipEmptyRows

  public final void setSkipEmptyRows(boolean value)

  Disables empty rows rendering.

• setTextOverflowMode

  public final void setTextOverflowMode(TextOverflowMode value)

  The text overflow mode for rendering spreadsheet documents into HTML.

  Parameters:

  value - The text overflow mode for rendering spreadsheet documents into HTML.