CsvLoadOptions class

CsvLoadOptions class

Options for loading Csv documents.

The CsvLoadOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of CsvLoadOptions.

Methods

Method Description
clone Clones current instance. (inherited from SpreadsheetLoadOptions)

Properties

Property Description
convert_date_time_data The property indicating whether strings in the file are converted to date values (default: True).
convert_numeric_data The property indicates whether the string in the file is converted to numeric. Default is True.
encoding The text encoding used for CSV files. Default is Encoding.Default.
format The input document file type.
has_formula The property indicates whether text is a formula if it starts with ‘=’.
is_multi_encoded The property indicates whether the file contains several encodings.
separator The delimiter of a CSV file.
all_columns_in_one_page_per_sheet The property determines whether all column content of a sheet is output to a single page. (inherited from SpreadsheetLoadOptions)
auto_fit_rows The rows are autofitted when converting. (inherited from SpreadsheetLoadOptions)
check_excel_restriction The property indicates whether to check Excel file restrictions when modifying cell-related objects. (inherited from SpreadsheetLoadOptions)
clear_built_in_document_properties The flag indicating whether built-in document properties are cleared. (inherited from SpreadsheetLoadOptions)
clear_custom_document_properties The ClearCustomDocumentProperties property indicates whether custom document properties are cleared when loading a spreadsheet. (inherited from SpreadsheetLoadOptions)
columns_per_page The number of columns per page used to split a worksheet into pages. Default is 0, meaning no pagination. (inherited from SpreadsheetLoadOptions)
convert_owned The property implements IDocumentsContainerLoadOptions.convert_owned. (inherited from SpreadsheetLoadOptions)
convert_owner The ConvertOwner flag indicates whether the owner of the converted document is set. (inherited from SpreadsheetLoadOptions)
convert_range The range to convert when converting to a format other than spreadsheet. Example: “D1:F8”. (inherited from SpreadsheetLoadOptions)
culture_info The system culture info used when the file is loaded. (inherited from SpreadsheetLoadOptions)
default_font The default font for a spreadsheet document, used when a font is missing. (inherited from SpreadsheetLoadOptions)
depth The depth of the spreadsheet load options, implementing IDocumentsContainerLoadOptions.depth; default is 1. (inherited from SpreadsheetLoadOptions)
font_substitutes The font substitutes used when converting a spreadsheet document. (inherited from SpreadsheetLoadOptions)
ignore_formula_calculation_errors The property indicates whether to ignore formula calculation errors. (inherited from SpreadsheetLoadOptions)
margin_settings The margin settings. See IPageMarginOptions for details. (inherited from SpreadsheetLoadOptions)
one_page_per_sheet The content of the sheet is converted to a single PDF page when one_page_per_sheet is True; default is True. (inherited from SpreadsheetLoadOptions)
optimize_pdf_size The conversion is optimized for better file size than print quality when set to True and converting to PDF. (inherited from SpreadsheetLoadOptions)
password The password used to unprotect a protected document. (inherited from SpreadsheetLoadOptions)
preserve_document_structure The property determines whether the document structure should be preserved when converting to PDF (default is False). (inherited from SpreadsheetLoadOptions)
print_comments The way comments are printed with the sheet; default is PrintNoComments. (inherited from SpreadsheetLoadOptions)
reset_font_folders The property resets font folders before loading a document. (inherited from SpreadsheetLoadOptions)
rows_per_page The number of rows per page used to split a worksheet into pages; a value of 0 disables pagination. (inherited from SpreadsheetLoadOptions)
sheet_indexes The list of sheet indexes to convert; the indexes must be zero-based. (inherited from SpreadsheetLoadOptions)
sheets The sheet name to convert. (inherited from SpreadsheetLoadOptions)
show_grid_lines The option to show grid lines when converting Excel files. (inherited from SpreadsheetLoadOptions)
show_hidden_sheets The option to show hidden sheets when converting Excel files. (inherited from SpreadsheetLoadOptions)
size_settings The size settings for the spreadsheet load operation. (inherited from SpreadsheetLoadOptions)
skip_empty_rows_and_columns The property that skips empty rows and columns when converting; default is True. (inherited from SpreadsheetLoadOptions)
skip_external_resources The property implements IResourceLoadingOptions.skip_external_resources. (inherited from SpreadsheetLoadOptions)
skip_footers The property skips footers when converting spreadsheet documents. Default: False. (inherited from SpreadsheetLoadOptions)
skip_headers The property indicates whether to skip headers when converting spreadsheet documents. Default: False. (inherited from SpreadsheetLoadOptions)
whitelisted_resources The whitelisted resources for loading, implementing IResourceLoadingOptions.whitelisted_resources. (inherited from SpreadsheetLoadOptions)

See Also