EbookLoadOptions
EbookLoadOptions class
Represents options when importing an ebook file.
new EbookLoadOptions()
Creates an options of loading the ebook file.
Methods
| Name | Description |
|---|---|
| constructor_overload$1(loadFormat) | Creates an options of loading the ebook file. |
| getAttachedFilesDirectory() | The directory that the attached files will be saved to. NOTE: This member is now obsolete. Instead, please use HtmlLoadO |
| getAutoFilter() | Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the correspondin |
| getAutoFitColsAndRows() | Indicates whether auto-fit columns and rows. The default value is false. |
| getAutoFitterOptions() | Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now. |
| getCheckDataValid() | Check whether data is valid in the template file. |
| getCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputt |
| getConvertDateTimeData() | Gets or sets a value that indicates whether the string in text file is converted to date data. |
| getConvertFormulasData() | if true, convert string to formula when string value starts with character ‘=’,the default value is false. NOTE: This pr |
| getConvertNumericData() | Gets or sets a value that indicates whether the string in text file is converted to numeric data. |
| getDefaultStyleSettings() | Gets the default style settings for initializing styles of the workbook |
| getDeleteRedundantSpaces() | Indicates whether delete redundant spaces when the text wraps lines using tag. The default value is false. |
| getDetectLaTeX() | |
| getEncoding() | Gets and sets the default encoding. Only applies for csv file. |
| getFontConfigs() | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| getHyperlinkLoadMode() | The value of the property is HyperlinkLoadMode integer constant. |
| getIgnoreNotPrinted() | Ignore the data which are not printed if directly printing the file Only for xlsx file. |
| getIgnoreUselessShapes() | Indicates whether ignoring useless shapes. Only works for xlsx,xlsb, and xlsm files. There are many overlapping identica |
| getInterruptMonitor() | Gets and sets the interrupt monitor. |
| getKeepPrecision() | Indicates whether not parsing a string value if the length is 15. |
| getKeepUnparsedData() | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For sce |
| getLanguageCode() | Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value |
| getLightCellsDataHandler() | The data handler for processing cells data when reading template file. |
| getLoadFilter() | The filter to denote how to load data. |
| getLoadFormat() | Gets the load format. The value of the property is LoadFormat integer constant. |
| getLoadFormulas() | Indicates whether importing formulas if the original html file contains formulas |
| getLoadStyleStrategy() | Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of |
| getLocale() | Gets and sets the Locale used for workbook at the time the file was loaded. |
| getMemorySetting() | Gets or sets the memory usage options. The value of the property is MemorySetting integer constant. |
| getParagrahLayoutMode() | The value of the property is HtmlParagraphLayoutMode integer constant. |
| getParsingFormulaOnOpen() | Indicates whether parsing the formula when reading the file. Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file becau |
| getParsingPivotCachedRecords() | Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel |
| getPassword() | Gets and set the password of the workbook. |
| getPreservePaddingSpacesInFormula() | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting |
| getProgId() | Gets the program id of creating the file. Only for MHT files. |
| getRegion() | Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the propert |
| getStandardFont() | Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This pr |
| getStandardFontSize() | Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This p |
| getStreamProvider() | Gets or sets the StreamProviderImportHtmlFile for importing objects. |
| getSupportDivTag() | Indicates whether support the layout of tag when the html file contains it. The default value is false. |
| getTableLoadOptions() | Get the HtmlTableLoadOptionCollection instance |
| getWarningCallback() | Gets or sets warning callback. |
| hasFormula() | Indicates whether the text is formula if it starts with “=”. |
| setAttachedFilesDirectory() | The directory that the attached files will be saved to. NOTE: This member is now obsolete. Instead, please use HtmlLoadO |
| setAutoFilter() | Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the correspondin |
| setAutoFitColsAndRows() | Indicates whether auto-fit columns and rows. The default value is false. |
| setAutoFitterOptions() | Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now. |
| setCheckDataValid() | Check whether data is valid in the template file. |
| setCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputt |
| setConvertDateTimeData() | Gets or sets a value that indicates whether the string in text file is converted to date data. |
| setConvertFormulasData() | if true, convert string to formula when string value starts with character ‘=’,the default value is false. NOTE: This pr |
| setConvertNumericData() | Gets or sets a value that indicates whether the string in text file is converted to numeric data. |
| setDeleteRedundantSpaces() | Indicates whether delete redundant spaces when the text wraps lines using tag. The default value is false. |
| setDetectLaTeX() | |
| setEncoding() | Gets and sets the default encoding. Only applies for csv file. |
| setFontConfigs() | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| setHasFormula() | Indicates whether the text is formula if it starts with “=”. |
| setHyperlinkLoadMode() | The value of the property is HyperlinkLoadMode integer constant. |
| setIgnoreNotPrinted() | Ignore the data which are not printed if directly printing the file Only for xlsx file. |
| setIgnoreUselessShapes() | Indicates whether ignoring useless shapes. Only works for xlsx,xlsb, and xlsm files. There are many overlapping identica |
| setInterruptMonitor() | Gets and sets the interrupt monitor. |
| setKeepPrecision() | Indicates whether not parsing a string value if the length is 15. |
| setKeepUnparsedData() | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For sce |
| setLanguageCode() | Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value |
| setLightCellsDataHandler() | The data handler for processing cells data when reading template file. |
| setLoadFilter() | The filter to denote how to load data. |
| setLoadFormulas() | Indicates whether importing formulas if the original html file contains formulas |
| setLoadStyleStrategy() | Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of |
| setLocale() | Gets and sets the Locale used for workbook at the time the file was loaded. |
| setMemorySetting() | Gets or sets the memory usage options. The value of the property is MemorySetting integer constant. |
| setPaperSize(type) | Sets the default print paper size from default printer’s setting. If there is no setting about paper size,MS Excel will |
| setParagrahLayoutMode() | The value of the property is HtmlParagraphLayoutMode integer constant. |
| setParsingFormulaOnOpen() | Indicates whether parsing the formula when reading the file. Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file becau |
| setParsingPivotCachedRecords() | Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel |
| setPassword() | Gets and set the password of the workbook. |
| setPreservePaddingSpacesInFormula() | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting |
| setRegion() | Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the propert |
| setStandardFont() | Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This pr |
| setStandardFontSize() | Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This p |
| setStreamProvider() | Gets or sets the StreamProviderImportHtmlFile for importing objects. |
| setSupportDivTag() | Indicates whether support the layout of tag when the html file contains it. The default value is false. |
| setWarningCallback() | Gets or sets warning callback. |
constructor_overload$1(loadFormat)
Creates an options of loading the ebook file.
| Parameter | Type | Description |
|---|---|---|
| loadFormat | Number | LoadFormat |
getAttachedFilesDirectory()
The directory that the attached files will be saved to. NOTE: This member is now obsolete. Instead, please use HtmlLoadOptions.StreamProvider property. This property will be removed 12 months later since December 2014. Aspose apologizes for any inconvenience you may have experienced.
getAutoFilter()
Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.
getAutoFitColsAndRows()
Indicates whether auto-fit columns and rows. The default value is false.
getAutoFitterOptions()
Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.
getCheckDataValid()
Check whether data is valid in the template file.
getCheckExcelRestriction()
Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.
getConvertDateTimeData()
Gets or sets a value that indicates whether the string in text file is converted to date data.
getConvertFormulasData()
if true, convert string to formula when string value starts with character ‘=’,the default value is false. NOTE: This property is now obsolete. Instead, please use HtmlLoadOptions.HasFormula property. This property will be removed 12 months later since March 2023. Aspose apologizes for any inconvenience you may have experienced.
getConvertNumericData()
Gets or sets a value that indicates whether the string in text file is converted to numeric data.
getDefaultStyleSettings()
Gets the default style settings for initializing styles of the workbook
getDeleteRedundantSpaces()
Indicates whether delete redundant spaces when the text wraps lines using tag. The default value is false.
getDetectLaTeX()
getEncoding()
Gets and sets the default encoding. Only applies for csv file.
getFontConfigs()
Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
getHyperlinkLoadMode()
The value of the property is HyperlinkLoadMode integer constant.
getIgnoreNotPrinted()
Ignore the data which are not printed if directly printing the file Only for xlsx file.
getIgnoreUselessShapes()
Indicates whether ignoring useless shapes. Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.
getInterruptMonitor()
Gets and sets the interrupt monitor.
getKeepPrecision()
Indicates whether not parsing a string value if the length is 15.
getKeepUnparsedData()
Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,
getLanguageCode()
Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.
getLightCellsDataHandler()
The data handler for processing cells data when reading template file.
getLoadFilter()
The filter to denote how to load data.
getLoadFormat()
Gets the load format. The value of the property is LoadFormat integer constant.
getLoadFormulas()
Indicates whether importing formulas if the original html file contains formulas
getLoadStyleStrategy()
Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.
getLocale()
Gets and sets the Locale used for workbook at the time the file was loaded.
getMemorySetting()
Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
getParagrahLayoutMode()
The value of the property is HtmlParagraphLayoutMode integer constant.
getParsingFormulaOnOpen()
Indicates whether parsing the formula when reading the file. Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.
getParsingPivotCachedRecords()
Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
getPassword()
Gets and set the password of the workbook.
getPreservePaddingSpacesInFormula()
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.
getProgId()
Gets the program id of creating the file. Only for MHT files.
getRegion()
Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file, please reset it after reading the file.
getStandardFont()
Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
getStandardFontSize()
Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
getStreamProvider()
Gets or sets the StreamProviderImportHtmlFile for importing objects.
getSupportDivTag()
Indicates whether support the layout of tag when the html file contains it. The default value is false.
getTableLoadOptions()
Get the HtmlTableLoadOptionCollection instance
getWarningCallback()
Gets or sets warning callback.
hasFormula()
Indicates whether the text is formula if it starts with “=”.
setAttachedFilesDirectory()
The directory that the attached files will be saved to. NOTE: This member is now obsolete. Instead, please use HtmlLoadOptions.StreamProvider property. This property will be removed 12 months later since December 2014. Aspose apologizes for any inconvenience you may have experienced.
setAutoFilter()
Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.
setAutoFitColsAndRows()
Indicates whether auto-fit columns and rows. The default value is false.
setAutoFitterOptions()
Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.
setCheckDataValid()
Check whether data is valid in the template file.
setCheckExcelRestriction()
Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.
setConvertDateTimeData()
Gets or sets a value that indicates whether the string in text file is converted to date data.
setConvertFormulasData()
if true, convert string to formula when string value starts with character ‘=’,the default value is false. NOTE: This property is now obsolete. Instead, please use HtmlLoadOptions.HasFormula property. This property will be removed 12 months later since March 2023. Aspose apologizes for any inconvenience you may have experienced.
setConvertNumericData()
Gets or sets a value that indicates whether the string in text file is converted to numeric data.
setDeleteRedundantSpaces()
Indicates whether delete redundant spaces when the text wraps lines using tag. The default value is false.
setDetectLaTeX()
setEncoding()
Gets and sets the default encoding. Only applies for csv file.
setFontConfigs()
Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
setHasFormula()
Indicates whether the text is formula if it starts with “=”.
setHyperlinkLoadMode()
The value of the property is HyperlinkLoadMode integer constant.
setIgnoreNotPrinted()
Ignore the data which are not printed if directly printing the file Only for xlsx file.
setIgnoreUselessShapes()
Indicates whether ignoring useless shapes. Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.
setInterruptMonitor()
Gets and sets the interrupt monitor.
setKeepPrecision()
Indicates whether not parsing a string value if the length is 15.
setKeepUnparsedData()
Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,
setLanguageCode()
Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.
setLightCellsDataHandler()
The data handler for processing cells data when reading template file.
setLoadFilter()
The filter to denote how to load data.
setLoadFormulas()
Indicates whether importing formulas if the original html file contains formulas
setLoadStyleStrategy()
Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.
setLocale()
Gets and sets the Locale used for workbook at the time the file was loaded.
setMemorySetting()
Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
setPaperSize(type)
Sets the default print paper size from default printer’s setting. If there is no setting about paper size,MS Excel will use default printer’s setting.
| Parameter | Type | Description |
|---|---|---|
| type | Number | PaperSizeType |
setParagrahLayoutMode()
The value of the property is HtmlParagraphLayoutMode integer constant.
setParsingFormulaOnOpen()
Indicates whether parsing the formula when reading the file. Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.
setParsingPivotCachedRecords()
Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
setPassword()
Gets and set the password of the workbook.
setPreservePaddingSpacesInFormula()
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.
setRegion()
Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file, please reset it after reading the file.
setStandardFont()
Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
setStandardFontSize()
Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.
setStreamProvider()
Gets or sets the StreamProviderImportHtmlFile for importing objects.
setSupportDivTag()
Indicates whether support the layout of tag when the html file contains it. The default value is false.
setWarningCallback()
Gets or sets warning callback.