SpreadsheetOptions (groupdocs-viewer (25.12) API Reference)

java.lang.Object
- com.groupdocs.viewer.options.SpreadsheetOptions

public class SpreadsheetOptions
extends Object

Provides options for rendering spreadsheets.

The SpreadsheetOptions class encapsulates various settings and parameters that can be used to control the rendering of spreadsheet files (such as Excel or CSV files) in the GroupDocs.Viewer component. For details, see children of the Render spreadsheet files topic.

Example usage:


 PngViewOptions pngViewOptions = new PngViewOptions();
 SpreadsheetOptions spreadsheetOptions = pngViewOptions.getSpreadsheetOptions();
 spreadsheetOptions.setRenderHeadings(true);
 spreadsheetOptions.setCountColumnsPerPage(24);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }

See Also:: Viewer, PngViewOptions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SpreadsheetOptions`	`forOnePagePerSheet()` Creates a new instance of `SpreadsheetOptions` class for rendering one sheet into one page.
`static SpreadsheetOptions`	`forRenderingByPageBreaks()` Initializes a new instance of the `SpreadsheetOptions` class for rendering print areas only.
`static SpreadsheetOptions`	`forRenderingPrintArea()` Initializes a new instance of the `SpreadsheetOptions` class for rendering print areas only.
`static SpreadsheetOptions`	`forRenderingPrintAreaAndPageBreaks()` Initializes a new instance of `SpreadsheetOptions` for rendering print areas and page breaks.
`static SpreadsheetOptions`	`forSplitSheetIntoPages(int countRowsPerPage)` Creates a new instance of `SpreadsheetOptions` class for rendering a sheet into multiple pages.
`static SpreadsheetOptions`	`forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)` Initializes a new instance of the `SpreadsheetOptions` class for rendering a sheet into pages.
`double`	`getBottomMargin()` To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used.
`int`	`getCountColumnsPerPage()` Gets the count of columns to include into each page when splitting the worksheet into pages.
`int`	`getCountRowsPerPage()` Gets the count of rows to include into each page when splitting the worksheet into pages.
`double`	`getLeftMargin()` To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used
`double`	`getRightMargin()` To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used.
`TextOverflowMode`	`getTextOverflowMode()` Returns the text overflow mode for rendering spreadsheet documents into HTML.
`double`	`getTopMargin()` To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used.
`boolean`	`isDetectSeparator()` Detects the separator for CSV/TSV files.
`boolean`	`isOnePagePerSheet()` Indicates whether one sheet is rendered into one page.
`boolean`	`isRenderByPageBreaks()` Determines whether the worksheet should be rendered by page breaks.
`boolean`	`isRenderGridLines()` Enables rendering of grid lines.
`boolean`	`isRenderHeadings()` Checks if headings rendering is enabled.
`boolean`	`isRenderHiddenColumns()` Enables hidden columns rendering.
`boolean`	`isRenderHiddenRows()` Determines whether hidden rows should be rendered.
`boolean`	`isRenderingPrintAreaAndPageBreaks()` When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area.
`boolean`	`isRenderPrintAreaOnly()` Indicates whether only the print areas are rendered.
`boolean`	`isSkipEmptyColumns()` Indicates whether empty columns should be skipped during rendering.
`boolean`	`isSkipEmptyRows()` Indicates whether empty rows should be skipped during rendering.
`void`	`setBottomMargin(double bottomMargin)` To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used.
`void`	`setCountColumnsPerPage(int countColumnsPerPage)` Sets the count of columns to include into each page when splitting the worksheet into pages.
`void`	`setDetectSeparator(boolean detectSeparator)` Sets whether to detect the separator for CSV/TSV files.
`void`	`setLeftMargin(double leftMargin)` To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used
`void`	`setRenderByPageBreaks(boolean renderByPageBreaks)` Sets whether the worksheet should be rendered by page breaks.
`void`	`setRenderGridLines(boolean value)` Enables or disables the rendering of grid lines.
`void`	`setRenderHeadings(boolean renderHeadings)` Enables headings rendering.
`void`	`setRenderHiddenColumns(boolean value)` Enables hidden columns rendering.
`void`	`setRenderHiddenRows(boolean value)` Sets whether hidden rows should be rendered.
`void`	`setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)` Sets whether to render a worksheet by page breaks that fall within the print area.
`void`	`setRightMargin(double rightMargin)` To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used.
`void`	`setSkipEmptyColumns(boolean value)` Sets whether empty columns should be skipped during rendering.
`void`	`setSkipEmptyRows(boolean value)` Sets whether empty rows should be skipped during rendering.
`void`	`setTextOverflowMode(TextOverflowMode value)` Sets the text overflow mode for rendering spreadsheet documents into HTML.
`void`	`setTopMargin(double topMargin)` To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - forOnePagePerSheet
```
public static SpreadsheetOptions forOnePagePerSheet()
```
    Creates a new instance of SpreadsheetOptions class for rendering one sheet into one page.
    For details, see the documentation.
    
    Returns:
    
    a new instance of SpreadsheetOptions class for rendering one sheet into one page.
  - forRenderingByPageBreaks
```
public static SpreadsheetOptions forRenderingByPageBreaks()
```
    Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. For details, see the documentation.
    
    Returns:
    
    a new instance of SpreadsheetOptions for rendering print areas only. The behavior is similar to printing in Excel, where the worksheet is rendered by page breaks.
  - forRenderingPrintArea
```
public static SpreadsheetOptions forRenderingPrintArea()
```
    Initializes a new instance of the SpreadsheetOptions class for rendering print areas only.
    For details, see the documentation.
    
    Returns:
    
    a new instance of the SpreadsheetOptions class for rendering print areas only.
  - forRenderingPrintAreaAndPageBreaks
```
public static SpreadsheetOptions forRenderingPrintAreaAndPageBreaks()
```
    Initializes a new instance of SpreadsheetOptions for rendering print areas and page breaks. For details, see the documentation.
    
    Returns:
    
    New instance of SpreadsheetOptions for rendering pages based on page breaks that are included into print area. The behavior is similar to printing in Excel.
  - forSplitSheetIntoPages
```
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage)
                                                 throws IllegalArgumentException
```
    Creates a new instance of SpreadsheetOptions class for rendering a sheet into multiple pages.
    For details, see the documentation.
    
    Parameters:
    
    countRowsPerPage - The number of rows to include in each page.
    
    Returns:
    
    a new instance of SpreadsheetOptions for rendering a sheet into pages.
    
    Throws:
    
    IllegalArgumentException - Thrown when countRowsPerPage is equal to or less than zero.
  - forSplitSheetIntoPages
```
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage,
                                                        int countColumnsPerPage)
```
    Initializes a new instance of the SpreadsheetOptions class for rendering a sheet into pages.
    For details, see the documentation.
    
    Parameters:
    
    countRowsPerPage - The number of rows to include on each page.
    
    countColumnsPerPage - The number of columns to include on each page.
    
    Returns:
    
    a new instance of the SpreadsheetOptions class for rendering a sheet into pages.
  - getBottomMargin
```
public double getBottomMargin()
```
    To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - getCountColumnsPerPage
```
public int getCountColumnsPerPage()
```
    Gets the count of columns to include into each page when splitting the worksheet into pages.
    
    For details, see the documentation.
    
    Returns:
    
    the count of columns to include into each page.
  - getCountRowsPerPage
```
public final int getCountRowsPerPage()
```
    Gets the count of rows to include into each page when splitting the worksheet into pages.
    
    For details, see the documentation.
    
    Returns:
    
    the count of rows to include into each page.
  - getLeftMargin
```
public double getLeftMargin()
```
    To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used
    If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - getRightMargin
```
public double getRightMargin()
```
    To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - getTextOverflowMode
```
public final TextOverflowMode getTextOverflowMode()
```
    Returns the text overflow mode for rendering spreadsheet documents into HTML.
    For details, see the documentation.
    
    Returns:
    
    the text overflow mode.
  - getTopMargin
```
public double getTopMargin()
```
    To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - isDetectSeparator
```
public boolean isDetectSeparator()
```
    Detects the separator for CSV/TSV files.
    
    For details, see the documentation.
    
    Returns:
    
    true if the separator should be automatically detected, false otherwise.
  - isOnePagePerSheet
```
public final boolean isOnePagePerSheet()
```
    Indicates whether one sheet is rendered into one page.
    
    Returns:
    
    true if one sheet is rendered into one page; false otherwise.
  - isRenderByPageBreaks
```
public boolean isRenderByPageBreaks()
```
    Determines whether the worksheet should be rendered by page breaks.
    
    Note: This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.
    
    Returns:
    
    true if the worksheet should be rendered by page breaks, false otherwise.
  - isRenderGridLines
```
public final boolean isRenderGridLines()
```
    Enables rendering of grid lines.
    
    For details, see the documentation.
    
    Returns:
    
    true if grid lines are enabled, false otherwise.
  - isRenderHeadings
```
public boolean isRenderHeadings()
```
    Checks if headings rendering is enabled.
    
    For details, see the documentation.
    
    Returns:
    
    true if headings rendering is enabled, false otherwise.
  - isRenderHiddenColumns
```
public final boolean isRenderHiddenColumns()
```
    Enables hidden columns rendering.
    
    For details, see the documentation.
    
    Returns:
    
    true if hidden columns rendering is enabled, false otherwise.
  - isRenderHiddenRows
```
public final boolean isRenderHiddenRows()
```
    Determines whether hidden rows should be rendered.
    
    For details, see the documentation.
    
    Returns:
    
    true if hidden rows should be rendered, false otherwise.
  - isRenderingPrintAreaAndPageBreaks
```
public boolean isRenderingPrintAreaAndPageBreaks()
```
    When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area.
  - isRenderPrintAreaOnly
```
public final boolean isRenderPrintAreaOnly()
```
    Indicates whether only the print areas are rendered.
    
    Returns:
    
    true if only the print areas are rendered, false otherwise.
  - isSkipEmptyColumns
```
public final boolean isSkipEmptyColumns()
```
    Indicates whether empty columns should be skipped during rendering.
    
    For details, see the documentation.
    
    Returns:
    
    true if empty columns are skipped, false otherwise.
  - isSkipEmptyRows
```
public final boolean isSkipEmptyRows()
```
    Indicates whether empty rows should be skipped during rendering.
    
    For details, see the documentation.
    
    Returns:
    
    true if empty rows should be skipped, false otherwise.
  - setBottomMargin
```
public void setBottomMargin(double bottomMargin)
```
    To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - setCountColumnsPerPage
```
public void setCountColumnsPerPage(int countColumnsPerPage)
```
    Sets the count of columns to include into each page when splitting the worksheet into pages.
    
    For details, see the documentation.
    
    Parameters:
    
    countColumnsPerPage - The count of columns to include into each page.
  - setDetectSeparator
```
public void setDetectSeparator(boolean detectSeparator)
```
    Sets whether to detect the separator for CSV/TSV files.
    
    For details, see the documentation.
    
    Parameters:
    
    detectSeparator - true to automatically detect the separator, false otherwise.
  - setLeftMargin
```
public void setLeftMargin(double leftMargin)
```
    To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used
    If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - setRenderByPageBreaks
```
public void setRenderByPageBreaks(boolean renderByPageBreaks)
```
    Sets whether the worksheet should be rendered by page breaks.
    
    Note: This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.
    
    Parameters:
    
    renderByPageBreaks - true if the worksheet should be rendered by page breaks, false otherwise.
  - setRenderGridLines
```
public final void setRenderGridLines(boolean value)
```
    Enables or disables the rendering of grid lines.
    
    For details, see the documentation.
    
    Parameters:
    
    value - true to enable grid lines rendering, false to disable it.
  - setRenderHeadings
```
public void setRenderHeadings(boolean renderHeadings)
```
    Enables headings rendering.
    
    For details, see the documentation.
    
    Parameters:
    
    renderHeadings - true to enable headings rendering, false to disable.
  - setRenderHiddenColumns
```
public final void setRenderHiddenColumns(boolean value)
```
    Enables hidden columns rendering.
    
    For details, see the documentation.
    
    Parameters:
    
    value - true to enable hidden columns rendering, false to disable.
  - setRenderHiddenRows
```
public final void setRenderHiddenRows(boolean value)
```
    Sets whether hidden rows should be rendered.
    
    For details, see the documentation.
    
    Parameters:
    
    value - true to enable rendering of hidden rows, false to disable it.
  - setRenderingPrintAreaAndPageBreaks
```
public void setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)
```
    Sets whether to render a worksheet by page breaks that fall within the print area.
    
    Parameters:
    
    renderingPrintAreaAndPageBreaks - Set to true to enable, false to disable.
  - setRightMargin
```
public void setRightMargin(double rightMargin)
```
    To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the documentation.
  - setSkipEmptyColumns
```
public final void setSkipEmptyColumns(boolean value)
```
    Sets whether empty columns should be skipped during rendering.
    
    For details, see the documentation.
    
    Parameters:
    
    value - true to skip empty columns, false otherwise.
  - setSkipEmptyRows
```
public final void setSkipEmptyRows(boolean value)
```
    Sets whether empty rows should be skipped during rendering.
    
    For details, see the documentation.
    
    Parameters:
    
    value - true to skip empty rows, false otherwise.
  - setTextOverflowMode
```
public final void setTextOverflowMode(TextOverflowMode value)
```
    Sets the text overflow mode for rendering spreadsheet documents into HTML. For details, see the documentation.
    
    Parameters:
    
    value - The text overflow mode to be set.
  - setTopMargin
```
public void setTopMargin(double topMargin)
```
    To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the documentation.

Class SpreadsheetOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forOnePagePerSheet

forRenderingByPageBreaks

forRenderingPrintArea

forRenderingPrintAreaAndPageBreaks

forSplitSheetIntoPages

forSplitSheetIntoPages

getBottomMargin

getCountColumnsPerPage

getCountRowsPerPage

getLeftMargin

getRightMargin

getTextOverflowMode

getTopMargin

isDetectSeparator

isOnePagePerSheet

isRenderByPageBreaks

isRenderGridLines

isRenderHeadings

isRenderHiddenColumns

isRenderHiddenRows

isRenderingPrintAreaAndPageBreaks

isRenderPrintAreaOnly

isSkipEmptyColumns

isSkipEmptyRows

setBottomMargin

setCountColumnsPerPage

setDetectSeparator

setLeftMargin

setRenderByPageBreaks

setRenderGridLines

setRenderHeadings

setRenderHiddenColumns

setRenderHiddenRows

setRenderingPrintAreaAndPageBreaks

setRightMargin

setSkipEmptyColumns

setSkipEmptyRows

setTextOverflowMode

setTopMargin