com.groupdocs.viewer.options

Class SpreadsheetOptions



  • public class SpreadsheetOptions
    extends Object

    Provides options for rendering spreadsheets.

    • Field Detail

      • COUNT_ROWS_PER_PAGE_DEFAULT

        public static final int COUNT_ROWS_PER_PAGE_DEFAULT
        See Also:
        Constant Field Values
    • Method Detail

      • 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.
      • isOnePagePerSheet

        public final boolean isOnePagePerSheet()

        Indicates that one sheet is rendered into one page.

      • 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.
      • 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.