SpreadsheetLoadOptions class
Leave feedback
On this page
Provides options for loading Spreadsheet documents.
The SpreadsheetLoadOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of SpreadsheetLoadOptions. |
| Method | Description |
|---|---|
| clone | Clones current instance. |
| equals | Determines whether two object instances are equal. (inherited from ValueObject) |
| equals_object | (inherited from ValueObject) |
| equals_value_object | (inherited from ValueObject) |
| get_hash_code | Serves as the default hash function. (inherited from ValueObject) |
| Property | Description |
|---|---|
| all_columns_in_one_page_per_sheet | The property determines whether all column content of a sheet is rendered on a single page in the result. |
| auto_fit_rows | The rows are autofitted when converting. |
| check_excel_restriction | The property determines whether Excel file restrictions are checked when modifying cell-related objects. |
| clear_built_in_document_properties | The ClearBuiltInDocumentProperties property determines whether built‑in document properties are cleared when loading a spreadsheet. |
| clear_custom_document_properties | The ClearCustomDocumentProperties property. |
| columns_per_page | The number of columns per page used to split a worksheet into pages; default is 0, which disables pagination. |
| convert_owned | The property implements IDocumentsContainerLoadOptions.convert_owned and defaults to False. |
| convert_owner | The property that implements IDocumentsContainerLoadOptions.convert_owner. Default is True. |
| convert_range | The range to convert when converting to a non‑spreadsheet format, e.g. “D1:F8”. |
| culture_info | The system culture info used when the file is loaded. |
| default_font | The default font for a spreadsheet document. |
| depth | The depth of the documents container load options. |
| font_substitutes | The font substitutes used when converting a spreadsheet document. |
| format | The input document file type. |
| ignore_formula_calculation_errors | The property indicates whether to ignore formula calculation errors. The error may be unsupported function, external links, etc. Default is False. |
| margin_settings | The margin settings. |
| one_page_per_sheet | The property indicates whether the content of each sheet is converted to a single page in the PDF document. Default value is True. |
| optimize_pdf_size | The conversion is optimized for smaller file size rather than print quality when set to True while converting to PDF. |
| password | The password used to unprotect a protected document. |
| preserve_document_structure | The flag indicating whether the document structure should be preserved when converting to PDF (default is False). |
| print_comments | The way comments are printed with the sheet. Default is PrintNoComments. |
| reset_font_folders | The font folders are reset before loading the document. |
| rows_per_page | The number of rows per page used to split a worksheet into pages, with a default of 0 meaning no pagination. |
| sheet_indexes | The list of sheet indexes to convert. |
| sheets | The sheet name to convert. |
| show_grid_lines | The option to show grid lines when converting Excel files. |
| show_hidden_sheets | The option to show hidden sheets when converting Excel files. |
| size_settings | The size settings, as defined by IPageSizeOptions. |
| skip_empty_rows_and_columns | The setting that skips empty rows and columns when converting. |
| skip_external_resources | The property implements IResourceLoadingOptions.skip_external_resources. |
| skip_footers | The property determines whether footers are skipped when converting spreadsheet documents. Default: False. |
| skip_headers | The option to skip headers when converting spreadsheet documents. Default: False. |
| whitelisted_resources | The whitelisted resources as defined by IResourceLoadingOptions.whitelisted_resources. |
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.