Aspose::Cells::TxtLoadOptions class
Contents
[
Hide
]TxtLoadOptions class
Represents the options for loading text file.
class TxtLoadOptions : public Aspose::Cells::AbstractTextLoadOptions
Methods
| Method | Description |
|---|---|
| AbstractTextLoadOptions(AbstractTextLoadOptions_Impl* impl) | Constructs from an implementation object. |
| AbstractTextLoadOptions(const AbstractTextLoadOptions& src) | Copy constructor. |
| AbstractTextLoadOptions(const LoadOptions& src) | Constructs from a parent object. |
| 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. |
| GetConvertDateTimeData() | Gets or sets a value that indicates whether the string in text file is converted to date data. |
| 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. |
| GetEncoding() | Gets and sets the default encoding. Only applies for csv file. |
| GetExtendToNextSheet() | Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false. |
| GetFontConfigs() | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| GetHasFormula() | Indicates whether the text is formula if it starts with “=”. |
| GetHasTextQualifier() | Whether there is text qualifier for cell value. Default is true. |
| GetHeaderColumnsCount() | The count of header columns to be repeated for extended sheets. |
| GetHeaderRowsCount() | The count of header rows to be repeated for extended sheets. |
| GetIgnoreNotPrinted() | Ignore the data which are not printed if directly printing the file. |
| GetIgnoreUselessShapes() | Indicates whether ignoring useless shapes. |
| 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. |
| 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. |
| GetLoadStyleStrategy() | Indicates the strategy to apply style for parsed values when converting string value to number or datetime. |
| GetMaxColumnCount() | The maximum count of columns to be imported for one sheet. |
| GetMaxRowCount() | The maximum count of rows to be imported for one sheet. |
| 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. |
| GetSeparator() | Gets and sets character separator of text file. |
| GetSeparatorString() | Gets and sets a string value as separator. |
| GetTextQualifier() | Specifies the text qualifier for cell values. Default qualifier is ‘"’. |
| GetTreatConsecutiveDelimitersAsOne() | Whether consecutive delimiters should be treated as one. |
| GetTreatQuotePrefixAsValue() | Indicates whether the leading single quote sign should be taken as part of the value of one cell. Default is true. If it is false, the leading single quote will be removed from corresponding cell’s value and Style.QuotePrefix will be set as true for the cell. |
| GetWarningCallback() | Gets or sets warning callback. |
| IsMultiEncoded() | True means that the file contains several encoding. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| 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 TxtLoadOptions& src) | operator= |
| operator=(const AbstractTextLoadOptions& 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. |
| SetConvertDateTimeData(bool value) | Gets or sets a value that indicates whether the string in text file is converted to date data. |
| SetConvertNumericData(bool value) | Gets or sets a value that indicates whether the string in text file is converted to numeric data. |
| SetEncoding(EncodingType value) | Gets and sets the default encoding. Only applies for csv file. |
| SetExtendToNextSheet(bool value) | Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false. |
| SetFontConfigs(const IndividualFontConfigs& value) | Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load. |
| SetHasFormula(bool value) | Indicates whether the text is formula if it starts with “=”. |
| SetHasTextQualifier(bool value) | Whether there is text qualifier for cell value. Default is true. |
| SetHeaderColumnsCount(int32_t value) | The count of header columns to be repeated for extended sheets. |
| SetHeaderRowsCount(int32_t value) | The count of header rows to be repeated for extended sheets. |
| SetIgnoreNotPrinted(bool value) | Ignore the data which are not printed if directly printing the file. |
| SetIgnoreUselessShapes(bool value) | Indicates whether ignoring useless shapes. |
| SetInterruptMonitor(AbstractInterruptMonitor* value) | Gets and sets the interrupt monitor. |
| SetIsMultiEncoded(bool value) | True means that the file contains several encoding. |
| SetKeepPrecision(bool value) | Indicates whether not parsing a string value if the length is 15. |
| 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. |
| SetLoadStyleStrategy(TxtLoadStyleStrategy value) | Indicates the strategy to apply style for parsed values when converting string value to number or datetime. |
| SetMaxColumnCount(int32_t value) | The maximum count of columns to be imported for one sheet. |
| SetMaxRowCount(int32_t value) | The maximum count of rows to be imported for one sheet. |
| SetMemorySetting(MemorySetting value) | Gets or sets the memory usage options. |
| 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. |
| SetSeparator(char16_t value) | Gets and sets character separator of text file. |
| SetSeparatorString(const U16String& value) | Gets and sets a string value as separator. |
| SetSeparatorString(const char16_t* value) | Gets and sets a string value as separator. |
| SetTextQualifier(char16_t value) | Specifies the text qualifier for cell values. Default qualifier is ‘"’. |
| SetTreatConsecutiveDelimitersAsOne(bool value) | Whether consecutive delimiters should be treated as one. |
| SetTreatQuotePrefixAsValue(bool value) | Indicates whether the leading single quote sign should be taken as part of the value of one cell. Default is true. If it is false, the leading single quote will be removed from corresponding cell’s value and Style.QuotePrefix will be set as true for the cell. |
| SetWarningCallback(IWarningCallback* value) | Gets or sets warning callback. |
| TxtLoadOptions() | Creates the options for loading text file. |
| explicit TxtLoadOptions(LoadFormat loadFormat) | Creates the options for loading text file. |
| TxtLoadOptions(TxtLoadOptions_Impl* impl) | Constructs from an implementation object. |
| TxtLoadOptions(const TxtLoadOptions& src) | Copy constructor. |
| TxtLoadOptions(const AbstractTextLoadOptions& src) | Constructs from a parent object. |
| ~AbstractTextLoadOptions() | Destructor. |
| ~LoadOptions() | Destructor. |
| ~TxtLoadOptions() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class AbstractTextLoadOptions
- Namespace Aspose::Cells
- Library Aspose.Cells for C++