SpreadsheetOptions Leave feedback
On this page
Inheritance: java.lang.Object
public class SpreadsheetOptions
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
}
| Method | Description |
|---|---|
| isRenderByPageBreaks() | Determines whether the worksheet should be rendered by page breaks. |
| setRenderByPageBreaks(boolean renderByPageBreaks) | Sets whether the worksheet should be rendered by page breaks. |
| isDetectSeparator() | Detects the separator for CSV/TSV files. |
| setDetectSeparator(boolean detectSeparator) | Sets whether to detect the separator for CSV/TSV files. |
| forOnePagePerSheet() | Creates a new instance of SpreadsheetOptions class for rendering one sheet into one page. |
| forSplitSheetIntoPages(int countRowsPerPage) | Creates a new instance of SpreadsheetOptions class for rendering a sheet into multiple pages. |
| forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage) | Initializes a new instance of the SpreadsheetOptions class for rendering a sheet into pages. |
| forRenderingPrintArea() | Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. |
| isOnePagePerSheet() | Indicates whether one sheet is rendered into one page. |
| getCountRowsPerPage() | Gets the count of rows to include into each page when splitting the worksheet into pages. |
| getCountColumnsPerPage() | Gets the count of columns to include into each page when splitting the worksheet into pages. |
| setCountColumnsPerPage(int countColumnsPerPage) | Sets the count of columns to include into each page when splitting the worksheet into pages. |
| isRenderPrintAreaOnly() | Indicates whether only the print areas are rendered. |
| isRenderingPrintAreaAndPageBreaks() | When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area. |
| setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks) | Sets whether to render a worksheet by page breaks that fall within the print area. |
| isRenderGridLines() | Enables rendering of grid lines. |
| setRenderGridLines(boolean value) | Enables or disables the rendering of grid lines. |
| isSkipEmptyRows() | Indicates whether empty rows should be skipped during rendering. |
| setSkipEmptyRows(boolean value) | Sets whether empty rows should be skipped during rendering. |
| isSkipEmptyColumns() | Indicates whether empty columns should be skipped during rendering. |
| setSkipEmptyColumns(boolean value) | Sets whether empty columns should be skipped during rendering. |
| isRenderHiddenRows() | Determines whether hidden rows should be rendered. |
| setRenderHiddenRows(boolean value) | Sets whether hidden rows should be rendered. |
| isRenderHeadings() | Checks if headings rendering is enabled. |
| setRenderHeadings(boolean renderHeadings) | Enables headings rendering. |
| isRenderHiddenColumns() | Enables hidden columns rendering. |
| setRenderHiddenColumns(boolean value) | Enables hidden columns rendering. |
| getTextOverflowMode() | Returns the text overflow mode for rendering spreadsheet documents into HTML. |
| setTextOverflowMode(TextOverflowMode value) | Sets the text overflow mode for rendering spreadsheet documents into HTML. |
| getLeftMargin() | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used |
| setLeftMargin(double leftMargin) | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| getHorizontalResolution() | Gets or sets the horizontal resolution for generated images in dots per inch. |
| setHorizontalResolution(int horizontalResolution) | Sets the horizontal resolution for generated images in dots per inch. |
| getVerticalResolution() | Gets or sets the vertical resolution for generated images in dots per inch. |
| setVerticalResolution(int verticalResolution) | Sets the vertical resolution for generated images in dots per inch. |
| getValidHorizontalDpi() | |
| getValidVerticalDpi() | |
| forRenderingPrintAreaAndPageBreaks() | Initializes a new instance of SpreadsheetOptions for rendering print areas and page breaks. |
| forRenderingByPageBreaks() | Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. |
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: boolean - true if the worksheet should be rendered by page breaks, false otherwise.
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:
| Parameter | Type | Description |
|---|---|---|
| renderByPageBreaks | boolean | true if the worksheet should be rendered by page breaks, false otherwise. |
public boolean isDetectSeparator()
Detects the separator for CSV/TSV files.
For details, see the documentation.
Returns: boolean - true if the separator should be automatically detected, false otherwise.
public void setDetectSeparator(boolean detectSeparator)
Sets whether to detect the separator for CSV/TSV files.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| detectSeparator | boolean | true to automatically detect the separator, false otherwise. |
public static SpreadsheetOptions forOnePagePerSheet()
Creates a new instance of SpreadsheetOptions class for rendering one sheet into one page.
For details, see the documentation.
Returns: SpreadsheetOptions - a new instance of SpreadsheetOptions class for rendering one sheet into one page.
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage)
Creates a new instance of SpreadsheetOptions class for rendering a sheet into multiple pages.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| countRowsPerPage | int | The number of rows to include in each page. |
Returns: SpreadsheetOptions - a new instance of SpreadsheetOptions for rendering a sheet into pages.
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:
| Parameter | Type | Description |
|---|---|---|
| countRowsPerPage | int | The number of rows to include on each page. |
| countColumnsPerPage | int | The number of columns to include on each page. |
Returns: SpreadsheetOptions - a new instance of the SpreadsheetOptions class for rendering a sheet into pages.
public static SpreadsheetOptions forRenderingPrintArea()
Initializes a new instance of the SpreadsheetOptions class for rendering print areas only.
For details, see the documentation.
Returns: SpreadsheetOptions - a new instance of the SpreadsheetOptions class for rendering print areas only.
public final boolean isOnePagePerSheet()
Indicates whether one sheet is rendered into one page.
Returns: boolean - true if one sheet is rendered into one page; false otherwise.
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: int - the count of rows to include into each page.
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: int - the count of columns to include into each page.
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:
| Parameter | Type | Description |
|---|---|---|
| countColumnsPerPage | int | The count of columns to include into each page. |
public final boolean isRenderPrintAreaOnly()
Indicates whether only the print areas are rendered.
Returns: boolean - true if only the print areas are rendered, false otherwise.
public boolean isRenderingPrintAreaAndPageBreaks()
When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area.
Returns: boolean
public void setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)
Sets whether to render a worksheet by page breaks that fall within the print area.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| renderingPrintAreaAndPageBreaks | boolean | Set to true to enable, false to disable. |
public final boolean isRenderGridLines()
Enables rendering of grid lines.
For details, see the documentation.
Returns: boolean - true if grid lines are enabled, false otherwise.
public final void setRenderGridLines(boolean value)
Enables or disables the rendering of grid lines.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | true to enable grid lines rendering, false to disable it. |
public final boolean isSkipEmptyRows()
Indicates whether empty rows should be skipped during rendering.
For details, see the documentation.
Returns: boolean - true if empty rows should be skipped, false otherwise.
public final void setSkipEmptyRows(boolean value)
Sets whether empty rows should be skipped during rendering.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | true to skip empty rows, false otherwise. |
public final boolean isSkipEmptyColumns()
Indicates whether empty columns should be skipped during rendering.
For details, see the documentation.
Returns: boolean - true if empty columns are skipped, false otherwise.
public final void setSkipEmptyColumns(boolean value)
Sets whether empty columns should be skipped during rendering.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | true to skip empty columns, false otherwise. |
public final boolean isRenderHiddenRows()
Determines whether hidden rows should be rendered.
For details, see the documentation.
Returns: boolean - true if hidden rows should be rendered, false otherwise.
public final void setRenderHiddenRows(boolean value)
Sets whether hidden rows should be rendered.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | true to enable rendering of hidden rows, false to disable it. |
public boolean isRenderHeadings()
Checks if headings rendering is enabled.
For details, see the documentation.
Returns: boolean - true if headings rendering is enabled, false otherwise.
public void setRenderHeadings(boolean renderHeadings)
Enables headings rendering.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| renderHeadings | boolean | true to enable headings rendering, false to disable. |
public final boolean isRenderHiddenColumns()
Enables hidden columns rendering.
For details, see the documentation.
Returns: boolean - true if hidden columns rendering is enabled, false otherwise.
public final void setRenderHiddenColumns(boolean value)
Enables hidden columns rendering.
For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | true to enable hidden columns rendering, false to disable. |
public final TextOverflowMode getTextOverflowMode()
Returns the text overflow mode for rendering spreadsheet documents into HTML.
For details, see the documentation.
Returns: TextOverflowMode - the text overflow mode.
public final void setTextOverflowMode(TextOverflowMode value)
Sets the text overflow mode for rendering spreadsheet documents into HTML. For details, see the documentation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TextOverflowMode | The text overflow mode to be set. |
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.
Returns: double
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| leftMargin | double |
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.
Returns: double
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rightMargin | double |
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.
Returns: double
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| topMargin | double |
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.
Returns: double
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| bottomMargin | double |
public int getHorizontalResolution()
Gets or sets the horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.
Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.
Returns: int - the horizontal resolution in DPI.
public void setHorizontalResolution(int horizontalResolution)
Sets the horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.
Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| horizontalResolution | int | the horizontal resolution in DPI. |
public int getVerticalResolution()
Gets or sets the vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.
Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.
Returns: int - the vertical resolution in DPI.
public void setVerticalResolution(int verticalResolution)
Sets the vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.
Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| verticalResolution | int | the vertical resolution in DPI. |
public int getValidHorizontalDpi()
Returns: int
public int getValidVerticalDpi()
Returns: int
public static SpreadsheetOptions forRenderingPrintAreaAndPageBreaks()
Initializes a new instance of SpreadsheetOptions for rendering print areas and page breaks. For details, see the documentation.
Returns: SpreadsheetOptions - 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.
public static SpreadsheetOptions forRenderingByPageBreaks()
Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. For details, see the documentation.
Returns: SpreadsheetOptions - 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.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
