TxtLoadOptions
Inheritance: java.lang.Object, com.aspose.cells.LoadOptions, com.aspose.cells.AbstractTextLoadOptions
public class TxtLoadOptions extends AbstractTextLoadOptions
Represents the options for loading text file.
Constructors
| Constructor | Description |
|---|---|
| TxtLoadOptions() | Creates the options for loading text file. |
| TxtLoadOptions(int loadFormat) | Creates the options for loading text file. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAutoFilter() | Indicates whether auto filtering the data when loading the files. |
| getAutoFitterOptions() | Gets 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. |
| getClass() | |
| getConvertDateTimeData() | Gets a value that indicates whether the string in text file is converted to date data. |
| getConvertNumericData() | Gets 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 the default encoding. |
| getExtendToNextSheet() | Whether extends data to next sheet when the rows or columns of data exceed limit. |
| getFontConfigs() | Gets individual font configs. |
| getIgnoreNotPrinted() | Ignore the data which are not printed if directly printing the file Only for xlsx file. |
| getInterruptMonitor() | Gets 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. |
| getLanguageCode() | Gets 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. |
| getLocale() | Gets the Locale used for workbook at the time the file was loaded. |
| getMemorySetting() | Gets 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. |
| getPassword() | Gets the password of the workbook. |
| getPreferredParsers() | Gets preferred value parsers for loading text file. |
| getRegion() | Gets the system regional settings based on CountryCode at the time the file was loaded. |
| getSeparator() | Gets character separator of text file. |
| getSeparatorString() | Gets a string value as separator. |
| getStandardFont() | Sets the default standard font name NOTE: This member is now obsolete. |
| getStandardFontSize() | Sets the default standard font size. |
| getTextQualifier() | Specifies the text qualifier for cell values. |
| 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. |
| getWarningCallback() | Gets warning callback. |
| hasFormula() | Indicates whether the text is formula if it starts with “=”. |
| hasTextQualifier() | Whether there is text qualifier for cell value. |
| hashCode() | |
| isMultiEncoded() | True means that the file contains several encoding. |
| notify() | |
| notifyAll() | |
| setAutoFilter(boolean value) | Indicates whether auto filtering the data when loading the files. |
| setAutoFitterOptions(AutoFitterOptions value) | Sets the auto fitter options Only for xlsx ,spreadsheetML file now. |
| setCheckDataValid(boolean value) | Check whether data is valid in the template file. |
| setCheckExcelRestriction(boolean value) | Whether check restriction of excel file when user modify cells related objects. |
| setConvertDateTimeData(boolean value) | Sets a value that indicates whether the string in text file is converted to date data. |
| setConvertNumericData(boolean value) | Sets a value that indicates whether the string in text file is converted to numeric data. |
| setEncoding(Encoding value) | Sets the default encoding. |
| setExtendToNextSheet(boolean value) | Whether extends data to next sheet when the rows or columns of data exceed limit. |
| setFontConfigs(IndividualFontConfigs value) | Sets individual font configs. |
| setHasFormula(boolean value) | Indicates whether the text is formula if it starts with “=”. |
| setHasTextQualifier(boolean value) | Whether there is text qualifier for cell value. |
| setIgnoreNotPrinted(boolean value) | Ignore the data which are not printed if directly printing the file Only for xlsx file. |
| setInterruptMonitor(AbstractInterruptMonitor value) | Sets the interrupt monitor. |
| setKeepPrecision(boolean value) | Indicates whether not parsing a string value if the length is 15. |
| setKeepUnparsedData(boolean value) | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. |
| setLanguageCode(int value) | 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(int value) | Indicates the strategy to apply style for parsed values when converting string value to number or datetime. |
| setLocale(Locale value) | Sets the Locale used for workbook at the time the file was loaded. |
| setMemorySetting(int value) | Sets the memory usage options. |
| setMultiEncoded(boolean value) | True means that the file contains several encoding. |
| setPaperSize(int type) | Sets the default print paper size from default printer’s setting. |
| setParsingFormulaOnOpen(boolean value) | Indicates whether parsing the formula when reading the file. |
| setParsingPivotCachedRecords(boolean value) | Indicates whether parsing pivot cached records when loading the file. |
| setPassword(String value) | Sets the password of the workbook. |
| setPreferredParsers(ICustomParser[] value) | Sets preferred value parsers for loading text file. |
| setRegion(int value) | Sets the system regional settings based on CountryCode at the time the file was loaded. |
| setSeparator(char value) | Sets character separator of text file. |
| setSeparatorString(String value) | Sets a string value as separator. |
| setStandardFont(String value) | Sets the default standard font name NOTE: This member is now obsolete. |
| setStandardFontSize(double value) | Sets the default standard font size. |
| setTextQualifier(char value) | Specifies the text qualifier for cell values. |
| setTreatConsecutiveDelimitersAsOne(boolean value) | Whether consecutive delimiters should be treated as one. |
| setTreatQuotePrefixAsValue(boolean value) | Indicates whether the leading single quote sign should be taken as part of the value of one cell. |
| setWarningCallback(IWarningCallback value) | Sets warning callback. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
TxtLoadOptions()
public TxtLoadOptions()
Creates the options for loading text file. The default load file type is CSV .
TxtLoadOptions(int loadFormat)
public TxtLoadOptions(int loadFormat)
Creates the options for loading text file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| loadFormat | int | The loading format |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAutoFilter()
public boolean 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.
Returns: boolean
getAutoFitterOptions()
public AutoFitterOptions getAutoFitterOptions()
Gets the auto fitter options Only for xlsx ,spreadsheetML file now.
Returns: AutoFitterOptions
getCheckDataValid()
public boolean getCheckDataValid()
Check whether data is valid in the template file.
Returns: boolean
getCheckExcelRestriction()
public boolean 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.
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getConvertDateTimeData()
public boolean getConvertDateTimeData()
Gets a value that indicates whether the string in text file is converted to date data.
Returns: boolean
getConvertNumericData()
public boolean getConvertNumericData()
Gets a value that indicates whether the string in text file is converted to numeric data.
Returns: boolean
getDefaultStyleSettings()
public DefaultStyleSettings getDefaultStyleSettings()
Gets the default style settings for initializing styles of the workbook
Returns: DefaultStyleSettings
getEncoding()
public Encoding getEncoding()
Gets the default encoding. Only applies for csv file.
Returns: Encoding
getExtendToNextSheet()
public boolean getExtendToNextSheet()
Whether extends data to next sheet when the rows or columns of data exceed limit. If this property is true, extra data will be extended to next sheet behind current one(if current sheet is the last one, new sheet will be appended to current workbook). If this property is false, the data exceeds limit will be ignored. Default is false;
Returns: boolean
getFontConfigs()
public IndividualFontConfigs getFontConfigs()
Gets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
Returns: IndividualFontConfigs
getIgnoreNotPrinted()
public boolean getIgnoreNotPrinted()
Ignore the data which are not printed if directly printing the file Only for xlsx file.
Returns: boolean
getInterruptMonitor()
public AbstractInterruptMonitor getInterruptMonitor()
Gets the interrupt monitor.
Returns: AbstractInterruptMonitor
getKeepPrecision()
public boolean getKeepPrecision()
Indicates whether not parsing a string value if the length is 15.
Returns: boolean
getKeepUnparsedData()
public boolean 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,
Returns: boolean
getLanguageCode()
public int getLanguageCode()
Gets the user interface language of the Workbook version based on CountryCode that has saved the file.
Returns: int
getLightCellsDataHandler()
public LightCellsDataHandler getLightCellsDataHandler()
The data handler for processing cells data when reading template file.
Returns: LightCellsDataHandler
getLoadFilter()
public LoadFilter getLoadFilter()
The filter to denote how to load data.
Returns: LoadFilter
getLoadFormat()
public int getLoadFormat()
Gets the load format.
Returns: int
getLoadStyleStrategy()
public int getLoadStyleStrategy()
Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
Returns: int
getLocale()
public Locale getLocale()
Gets the Locale used for workbook at the time the file was loaded.
Returns: java.util.Locale
getMemorySetting()
public int getMemorySetting()
Gets the memory usage options.
Returns: int
getParsingFormulaOnOpen()
public boolean 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.
Returns: boolean
getParsingPivotCachedRecords()
public boolean 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
Returns: boolean
getPassword()
public String getPassword()
Gets the password of the workbook.
Returns: java.lang.String
getPreferredParsers()
public ICustomParser[] getPreferredParsers()
Gets preferred value parsers for loading text file. parsers[0] is the parser will be used for the first column in text template file, parsers[1] is the parser will be used for the second column, …etc. The last one(parsers[parsers.length-1]) will be used for all other columns start from parsers.length-1. If one item is null, the corresponding column will be parsed by the default parser of Aspose.Cells.
Returns: com.aspose.cells.ICustomParser[]
getRegion()
public int getRegion()
Gets the system regional settings based on CountryCode at the time the file was loaded. If you do not want to use the region saved in the file, please reset it after reading the file.
Returns: int
getSeparator()
public char getSeparator()
Gets character separator of text file.
Returns: char
getSeparatorString()
public String getSeparatorString()
Gets a string value as separator.
Returns: java.lang.String
getStandardFont()
public String 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.
Returns: java.lang.String
getStandardFontSize()
public double 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.
Returns: double
getTextQualifier()
public char getTextQualifier()
Specifies the text qualifier for cell values. Default qualifier is ‘"’. When setting this property, hasTextQualifier() will become true automatically.
Returns: char
getTreatConsecutiveDelimitersAsOne()
public boolean getTreatConsecutiveDelimitersAsOne()
Whether consecutive delimiters should be treated as one.
Returns: boolean
getTreatQuotePrefixAsValue()
public boolean 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.getQuotePrefix() will be set as true for the cell.
Returns: boolean
getWarningCallback()
public IWarningCallback getWarningCallback()
Gets warning callback.
Returns: IWarningCallback
hasFormula()
public boolean hasFormula()
Indicates whether the text is formula if it starts with “=”.
Returns: boolean
hasTextQualifier()
public boolean hasTextQualifier()
Whether there is text qualifier for cell value. Default is true.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
isMultiEncoded()
public boolean isMultiEncoded()
True means that the file contains several encoding.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAutoFilter(boolean value)
public void setAutoFilter(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setAutoFitterOptions(AutoFitterOptions value)
public void setAutoFitterOptions(AutoFitterOptions value)
Sets the auto fitter options Only for xlsx ,spreadsheetML file now.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | AutoFitterOptions |
setCheckDataValid(boolean value)
public void setCheckDataValid(boolean value)
Check whether data is valid in the template file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setCheckExcelRestriction(boolean value)
public void setCheckExcelRestriction(boolean 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setConvertDateTimeData(boolean value)
public void setConvertDateTimeData(boolean value)
Sets a value that indicates whether the string in text file is converted to date data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setConvertNumericData(boolean value)
public void setConvertNumericData(boolean value)
Sets a value that indicates whether the string in text file is converted to numeric data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setEncoding(Encoding value)
public void setEncoding(Encoding value)
Sets the default encoding. Only applies for csv file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Encoding |
setExtendToNextSheet(boolean value)
public void setExtendToNextSheet(boolean value)
Whether extends data to next sheet when the rows or columns of data exceed limit. If this property is true, extra data will be extended to next sheet behind current one(if current sheet is the last one, new sheet will be appended to current workbook). If this property is false, the data exceeds limit will be ignored. Default is false;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setFontConfigs(IndividualFontConfigs value)
public void setFontConfigs(IndividualFontConfigs value)
Sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IndividualFontConfigs |
setHasFormula(boolean value)
public void setHasFormula(boolean value)
Indicates whether the text is formula if it starts with “=”.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setHasTextQualifier(boolean value)
public void setHasTextQualifier(boolean value)
Whether there is text qualifier for cell value. Default is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setIgnoreNotPrinted(boolean value)
public void setIgnoreNotPrinted(boolean value)
Ignore the data which are not printed if directly printing the file Only for xlsx file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setInterruptMonitor(AbstractInterruptMonitor value)
public void setInterruptMonitor(AbstractInterruptMonitor value)
Sets the interrupt monitor.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | AbstractInterruptMonitor |
setKeepPrecision(boolean value)
public void setKeepPrecision(boolean value)
Indicates whether not parsing a string value if the length is 15.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setKeepUnparsedData(boolean value)
public void setKeepUnparsedData(boolean value)
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,
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setLanguageCode(int value)
public void setLanguageCode(int value)
Sets the user interface language of the Workbook version based on CountryCode that has saved the file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setLightCellsDataHandler(LightCellsDataHandler value)
public void setLightCellsDataHandler(LightCellsDataHandler value)
The data handler for processing cells data when reading template file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LightCellsDataHandler |
setLoadFilter(LoadFilter value)
public void setLoadFilter(LoadFilter value)
The filter to denote how to load data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LoadFilter |
setLoadStyleStrategy(int value)
public void setLoadStyleStrategy(int value)
Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setLocale(Locale value)
public void setLocale(Locale value)
Sets the Locale used for workbook at the time the file was loaded.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Locale |
setMemorySetting(int value)
public void setMemorySetting(int value)
Sets the memory usage options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setMultiEncoded(boolean value)
public void setMultiEncoded(boolean value)
True means that the file contains several encoding.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPaperSize(int type)
public void setPaperSize(int 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | The default paper size. |
setParsingFormulaOnOpen(boolean value)
public void setParsingFormulaOnOpen(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setParsingPivotCachedRecords(boolean value)
public void setParsingPivotCachedRecords(boolean value)
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
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPassword(String value)
public void setPassword(String value)
Sets the password of the workbook.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPreferredParsers(ICustomParser[] value)
public void setPreferredParsers(ICustomParser[] value)
Sets preferred value parsers for loading text file. parsers[0] is the parser will be used for the first column in text template file, parsers[1] is the parser will be used for the second column, …etc. The last one(parsers[parsers.length-1]) will be used for all other columns start from parsers.length-1. If one item is null, the corresponding column will be parsed by the default parser of Aspose.Cells.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ICustomParser[] |
setRegion(int value)
public void setRegion(int value)
Sets the system regional settings based on CountryCode at the time the file was loaded. If you do not want to use the region saved in the file, please reset it after reading the file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSeparator(char value)
public void setSeparator(char value)
Sets character separator of text file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | char |
setSeparatorString(String value)
public void setSeparatorString(String value)
Sets a string value as separator.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setStandardFont(String value)
public void setStandardFont(String value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setStandardFontSize(double value)
public void setStandardFontSize(double value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setTextQualifier(char value)
public void setTextQualifier(char value)
Specifies the text qualifier for cell values. Default qualifier is ‘"’. When setting this property, hasTextQualifier() will become true automatically.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | char |
setTreatConsecutiveDelimitersAsOne(boolean value)
public void setTreatConsecutiveDelimitersAsOne(boolean value)
Whether consecutive delimiters should be treated as one.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setTreatQuotePrefixAsValue(boolean value)
public void setTreatQuotePrefixAsValue(boolean 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.getQuotePrefix() will be set as true for the cell.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Sets warning callback.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |