SpreadsheetOptions class

SpreadsheetOptions class

The options for rendering spreadsheets.

For details, see the children of the Render spreadsheet files topic.

The SpreadsheetOptions type exposes the following members:

Methods

Method Description
for_one_page_per_sheet Initializes a SpreadsheetOptions instance for rendering the whole sheet into one page.
for_rendering_by_page_breaks Initializes a SpreadsheetOptions instance configured to split worksheets into pages by page breaks.
for_rendering_print_area Initializes an instance of the SpreadsheetOptions class for rendering the print areas only.
for_rendering_print_area_and_page_breaks Initializes an instance of the SpreadsheetOptions class for rendering print areas and page breaks.
for_split_sheet_into_pages Initializes a SpreadsheetOptions instance for rendering a sheet into pages.
for_split_sheet_into_pages Initializes a SpreadsheetOptions instance for rendering a sheet into pages.
for_split_sheet_into_pages_int32

Properties

Property Description
bottom_margin The bottom margin of a page when converting to PDF.
count_columns_per_page The columns count to include on each page when splitting the worksheet into pages.
count_rows_per_page The rows count to include on each page when splitting the worksheet into pages.
detect_separator The property enables detection of a separator for CSV/TSV files.
horizontal_resolution The horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.
left_margin The left margin of a page when converting to PDF.
render_grid_lines The property enables rendering of grid lines.
render_headings The property enables headings rendering.
render_hidden_columns The property enables rendering of hidden columns.
render_hidden_rows The property enables rendering of hidden rows.
right_margin The right margin of a page when converting to PDF.
skip_empty_columns The property disables rendering of empty columns.
skip_empty_rows The property disables rendering of empty rows.
text_overflow_mode The text overflow mode for rendering spreadsheet documents into HTML. The default is TextOverflowMode.OverlayIfNextIsEmpty, which mimics the default MS Excel behavior.
top_margin The top margin of a page when converting to PDF.
vertical_resolution The vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

Example

from groupdocs.viewer import Viewer
from groupdocs.viewer.options import PdfViewOptions

with Viewer("invoice.xlsx") as viewer:
    view_options = PdfViewOptions("output.pdf")
    # Enable rendering of grid lines in the spreadsheet.
    view_options.spreadsheet_options.render_grid_lines = True
    viewer.view(view_options)

See Also