EbookLoadOptions
EbookLoadOptions class
Represents options when importing an ebook file.
Constructors
| Name | Description |
|---|---|
| EbookLoadOptions | Creates an options of loading the ebook file. |
| EbookLoadOptions | Creates an options of loading the ebook file. |
Properties
| Name | Type | Description |
|---|---|---|
| AttachedFilesDirectory | String | The directory that the attached files will be saved to. NOTE: This member is now obsolete. Instead, please use HtmlLoadO |
| LoadFormulas | boolean | Indicates whether importing formulas if the original html file contains formulas |
| SupportDivTag | boolean | Indicates whether support the layout of tag when the html file contains it. The default value is false. |
| DeleteRedundantSpaces | boolean | Indicates whether delete redundant spaces when the text wraps lines using tag. The default value is false. |
| AutoFitColsAndRows | boolean | Indicates whether auto-fit columns and rows. The default value is false. |
| ConvertFormulasData | boolean | if true, convert string to formula when string value starts with character ‘=’,the default value is false. NOTE: This pr |
| HasFormula | boolean | Indicates whether the text is formula if it starts with “=”. |
| StreamProvider | IStreamProvider | Gets or sets the StreamProviderImportHtmlFile for importing objects. |
| ProgId | String | Gets the program id of creating the file. Only for MHT files. |
| TableLoadOptions | HtmlTableLoadOptionCollection | Get the HtmlTableLoadOptionCollection instance |
| DetectLaTeX | boolean | |
| ParagrahLayoutMode | int | The value of the property is HtmlParagraphLayoutMode integer constant. |
| HyperlinkLoadMode | int | The value of the property is HyperlinkLoadMode integer constant. |
| Encoding | Encoding | Gets and sets the default encoding. Only applies for csv file. |
| LoadStyleStrategy | int | Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of |
| ConvertNumericData | boolean | Gets or sets a value that indicates whether the string in text file is converted to numeric data. |
| ConvertDateTimeData | boolean | Gets or sets a value that indicates whether the string in text file is converted to date data. |
| KeepPrecision | boolean | Indicates whether not parsing a string value if the length is 15. |
| LoadFormat | int | Gets the load format. The value of the property is LoadFormat integer constant. |
| Password | String | Gets and set the password of the workbook. |
| ParsingFormulaOnOpen | boolean | Indicates whether parsing the formula when reading the file. Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file becau |
| ParsingPivotCachedRecords | boolean | Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel |
| LanguageCode | int | Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value |
| Region | int | Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the propert |
| Locale | Locale | Gets and sets the Locale used for workbook at the time the file was loaded. |
| DefaultStyleSettings | DefaultStyleSettings | Gets the default style settings for initializing styles of the workbook |
| StandardFont | String | Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This pr |
| StandardFontSize | float | Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This p |
| InterruptMonitor | AbstractInterruptMonitor | Gets and sets the interrupt monitor. |
| IgnoreNotPrinted | boolean | Ignore the data which are not printed if directly printing the file Only for xlsx file. |
| CheckDataValid | boolean | Check whether data is valid in the template file. |
| CheckExcelRestriction | boolean | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputt |
| KeepUnparsedData | boolean | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For sce |
| LoadFilter | LoadFilter | The filter to denote how to load data. |
| LightCellsDataHandler | LightCellsDataHandler | The data handler for processing cells data when reading template file. |
| MemorySetting | int | Gets or sets the memory usage options. The value of the property is MemorySetting integer constant. |
| WarningCallback | IWarningCallback | Gets or sets warning callback. |
| AutoFitterOptions | AutoFitterOptions | Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now. |
| AutoFilter | boolean | Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the correspondin |
| FontConfigs | IndividualFontConfigs | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| IgnoreUselessShapes | boolean | Indicates whether ignoring useless shapes. Only works for xlsx,xlsb, and xlsm files. There are many overlapping identica |
| PreservePaddingSpacesInFormula | boolean | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting |
Methods
| Name | Description |
|---|---|
| setPaperSize | Sets the default print paper size from default printer’s setting. |
If there is no setting about paper size,MS Excel will |
EbookLoadOptions() (1 of 2)
Creates an options of loading the ebook file.
EbookLoadOptions(loadFormat) (2 of 2)
Creates an options of loading the ebook file.
| Parameter | Type | Description |
|---|---|---|
| loadFormat | int | A LoadFormat value. The loading format |
EbookLoadOptions.AttachedFilesDirectory property
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.
Type: String
EbookLoadOptions.LoadFormulas property
Indicates whether importing formulas if the original html file contains formulas
Type: boolean
EbookLoadOptions.SupportDivTag property
Indicates whether support the layout of
Type: boolean
EbookLoadOptions.DeleteRedundantSpaces property
Indicates whether delete redundant spaces when the text wraps lines using
tag. The default value is false.
Type: boolean
EbookLoadOptions.AutoFitColsAndRows property
Indicates whether auto-fit columns and rows. The default value is false.
Type: boolean
EbookLoadOptions.ConvertFormulasData property
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.
Type: boolean
EbookLoadOptions.HasFormula property
Indicates whether the text is formula if it starts with “=”.
Type: boolean
EbookLoadOptions.StreamProvider property
Gets or sets the StreamProviderImportHtmlFile for importing objects.
Type: IStreamProvider
EbookLoadOptions.ProgId property
Gets the program id of creating the file. Only for MHT files.
Type: String
EbookLoadOptions.TableLoadOptions property
Get the HtmlTableLoadOptionCollection instance
Type: HtmlTableLoadOptionCollection
EbookLoadOptions.DetectLaTeX property
Type: boolean
EbookLoadOptions.ParagrahLayoutMode property
The value of the property is HtmlParagraphLayoutMode integer constant.
Type: int
EbookLoadOptions.HyperlinkLoadMode property
The value of the property is HyperlinkLoadMode integer constant.
Type: int
EbookLoadOptions.Encoding property
Gets and sets the default encoding. Only applies for csv file.
Type: Encoding
EbookLoadOptions.LoadStyleStrategy property
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.
Type: int
EbookLoadOptions.ConvertNumericData property
Gets or sets a value that indicates whether the string in text file is converted to numeric data.
Type: boolean
EbookLoadOptions.ConvertDateTimeData property
Gets or sets a value that indicates whether the string in text file is converted to date data.
Type: boolean
EbookLoadOptions.KeepPrecision property
Indicates whether not parsing a string value if the length is 15.
Type: boolean
EbookLoadOptions.LoadFormat property
Gets the load format. The value of the property is LoadFormat integer constant.
Type: int
EbookLoadOptions.Password property
Gets and set the password of the workbook.
Type: String
EbookLoadOptions.ParsingFormulaOnOpen property
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.
Type: boolean
EbookLoadOptions.ParsingPivotCachedRecords property
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
Type: boolean
EbookLoadOptions.LanguageCode property
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.
Type: int
EbookLoadOptions.Region property
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.
Type: int
EbookLoadOptions.Locale property
Gets and sets the Locale used for workbook at the time the file was loaded.
Type: Locale
EbookLoadOptions.DefaultStyleSettings property
Gets the default style settings for initializing styles of the workbook
Type: DefaultStyleSettings
EbookLoadOptions.StandardFont property
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.
Type: String
EbookLoadOptions.StandardFontSize property
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.
Type: float
EbookLoadOptions.InterruptMonitor property
Gets and sets the interrupt monitor.
Type: AbstractInterruptMonitor
EbookLoadOptions.IgnoreNotPrinted property
Ignore the data which are not printed if directly printing the file Only for xlsx file.
Type: boolean
EbookLoadOptions.CheckDataValid property
Check whether data is valid in the template file.
Type: boolean
EbookLoadOptions.CheckExcelRestriction property
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.
Type: boolean
EbookLoadOptions.KeepUnparsedData property
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,
Type: boolean
EbookLoadOptions.LoadFilter property
The filter to denote how to load data.
Type: LoadFilter
EbookLoadOptions.LightCellsDataHandler property
The data handler for processing cells data when reading template file.
Type: LightCellsDataHandler
EbookLoadOptions.MemorySetting property
Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
Type: int
EbookLoadOptions.WarningCallback property
Gets or sets warning callback.
Type: IWarningCallback
EbookLoadOptions.AutoFitterOptions property
Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.
Type: AutoFitterOptions
EbookLoadOptions.AutoFilter property
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.
Type: boolean
EbookLoadOptions.FontConfigs property
Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
Type: IndividualFontConfigs
EbookLoadOptions.IgnoreUselessShapes property
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.
Type: boolean
EbookLoadOptions.PreservePaddingSpacesInFormula property
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.
Type: boolean
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 | int | A PaperSizeType value. The default paper size. |