Aspose::Cells::XmlLoadOptions class
Contents
[
Hide
]XmlLoadOptions class
Represents the options of loading xml.
class XmlLoadOptions : public Aspose::Cells::LoadOptions
Methods
| Method | Description |
|---|---|
| Get_DateFormat() | Gets and sets the format of date value. |
| Get_NumberFormat() | Gets and sets the format of numeric value. |
| GetAutoFilter() | Indicates whether auto filtering the data when loading the files. |
| GetAutoFitterOptions() | Gets and sets the auto fitter options. |
| 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. |
| GetContainsMultipleWorksheets() | Indicates whether importing xml as multiple worksheets. |
| GetConvertNumericOrDate() | Indicates whether converting the value in xml file to numeric or date. |
| GetDefaultStyleSettings() | Gets the default style settings for initializing styles of the workbook. |
| GetFontConfigs() | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| GetIgnoreNotPrinted() | Ignore the data which are not printed if directly printing the file. |
| GetIgnoreRootAttributes() | Indicates whether ignore attributes of the root element. |
| GetIgnoreUselessShapes() | Indicates whether ignoring useless shapes. |
| GetInterruptMonitor() | Gets and sets the interrupt monitor. |
| GetKeepUnparsedData() | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. |
| GetLanguageCode() | Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. |
| 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. |
| GetMemorySetting() | Gets or sets the memory usage options. |
| GetParsingFormulaOnOpen() | Indicates whether parsing the formula when reading the file. |
| GetParsingPivotCachedRecords() | Indicates whether parsing pivot cached records when loading the file. The default value is false. |
| 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. |
| GetRegion() | Gets or sets the system regional settings based on CountryCode at the time the file was loaded. |
| GetStartCell() | Gets and sets the start cell. |
| GetWarningCallback() | Gets or sets warning callback. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| IsXmlMap() | Indicates whether mapping xml to Excel. The default value is false. |
| LoadOptions() | Creates an options of loading the file. |
| explicit LoadOptions(LoadFormat loadFormat) | Creates an options of loading the file. |
| LoadOptions(LoadOptions_Impl* impl) | Constructs from an implementation object. |
| LoadOptions(const LoadOptions& src) | Copy constructor. |
| explicit operator bool() const | operator bool() |
| operator=(const XmlLoadOptions& src) | operator= |
| operator=(const LoadOptions& src) | operator= |
| SetAutoFilter(bool value) | Indicates whether auto filtering the data when loading the files. |
| SetAutoFitterOptions(const AutoFitterOptions& value) | Gets and sets the auto fitter options. |
| SetCheckDataValid(bool value) | Check whether data is valid in the template file. |
| SetCheckExcelRestriction(bool value) | 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. |
| SetContainsMultipleWorksheets(bool value) | Indicates whether importing xml as multiple worksheets. |
| SetConvertNumericOrDate(bool value) | Indicates whether converting the value in xml file to numeric or date. |
| SetDateFormat(const U16String& value) | Gets and sets the format of date value. |
| SetDateFormat(const char16_t* value) | Gets and sets the format of date value. |
| SetFontConfigs(const IndividualFontConfigs& value) | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| SetIgnoreNotPrinted(bool value) | Ignore the data which are not printed if directly printing the file. |
| SetIgnoreRootAttributes(bool value) | Indicates whether ignore attributes of the root element. |
| SetIgnoreUselessShapes(bool value) | Indicates whether ignoring useless shapes. |
| SetInterruptMonitor(AbstractInterruptMonitor* value) | Gets and sets the interrupt monitor. |
| SetIsXmlMap(bool value) | Indicates whether mapping xml to Excel. The default value is false. |
| SetKeepUnparsedData(bool value) | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. |
| SetLanguageCode(CountryCode value) | Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. |
| SetLightCellsDataHandler(LightCellsDataHandler* value) | The data handler for processing cells data when reading template file. |
| SetLoadFilter(LoadFilter* value) | The filter to denote how to load data. |
| SetMemorySetting(MemorySetting value) | Gets or sets the memory usage options. |
| SetNumberFormat(const U16String& value) | Gets and sets the format of numeric value. |
| SetNumberFormat(const char16_t* value) | Gets and sets the format of numeric value. |
| SetPaperSize(PaperSizeType type) | Sets the default print paper size from default printer’s setting. |
| SetParsingFormulaOnOpen(bool value) | Indicates whether parsing the formula when reading the file. |
| SetParsingPivotCachedRecords(bool value) | Indicates whether parsing pivot cached records when loading the file. The default value is false. |
| SetPassword(const U16String& value) | Gets and set the password of the workbook. |
| SetPassword(const char16_t* value) | Gets and set the password of the workbook. |
| SetPreservePaddingSpacesInFormula(bool value) | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. |
| SetRegion(CountryCode value) | Gets or sets the system regional settings based on CountryCode at the time the file was loaded. |
| SetStartCell(const U16String& value) | Gets and sets the start cell. |
| SetStartCell(const char16_t* value) | Gets and sets the start cell. |
| SetWarningCallback(IWarningCallback* value) | Gets or sets warning callback. |
| XmlLoadOptions() | Represents the options of loading xml file. |
| explicit XmlLoadOptions(LoadFormat type) | Represents the options of loading xml file. |
| XmlLoadOptions(XmlLoadOptions_Impl* impl) | Constructs from an implementation object. |
| XmlLoadOptions(const XmlLoadOptions& src) | Copy constructor. |
| XmlLoadOptions(const LoadOptions& src) | Constructs from a parent object. |
| ~LoadOptions() | Destructor. |
| ~XmlLoadOptions() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class LoadOptions
- Namespace Aspose::Cells
- Library Aspose.Cells for C++