com.aspose.cells.TxtLoadOptions.html Maven / Gradle / Ivy

TxtLoadOptions

public TxtLoadOptions()

Creates the options for loading text file.

The default load file type is CSV .

TxtLoadOptions

public TxtLoadOptions(int loadFormat)

Creates the options for loading text file.

Parameters:

loadFormat - A LoadFormat value. The loading format

public char getSeparator() / public void setSeparator(char value)

Gets and sets character separator of text file.

public void setSeparator(char value)

public java.lang.String getSeparatorString() / public void setSeparatorString(java.lang.String value)

Gets and sets a string value as separator.

public void setSeparatorString(java.lang.String value)

public boolean isMultiEncoded() / public void setMultiEncoded(boolean value)

True means that the file contains several encoding.

public void setMultiEncoded(boolean value)

public com.aspose.cells.ICustomParser[] getPreferredParsers() / public void setPreferredParsers(com.aspose.cells.ICustomParser[] value)

Gets and 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.

public void setPreferredParsers(com.aspose.cells.ICustomParser[] value)

public boolean hasFormula() / public void setHasFormula(boolean value)

Indicates whether the text is formula if it starts with "=".

public void setHasFormula(boolean value)

public boolean hasTextQualifier() / public void setHasTextQualifier(boolean value)

Whether there is text qualifier for cell value. Default is true.

public void setHasTextQualifier(boolean value)

public char getTextQualifier() / public void setTextQualifier(char value)

Specifies the text qualifier for cell values. Default qualifier is '"'.

When setting this property, HasTextQualifier will become true automatically.

public void setTextQualifier(char value)

public boolean getTreatConsecutiveDelimitersAsOne() / public void setTreatConsecutiveDelimitersAsOne(boolean value)

Whether consecutive delimiters should be treated as one.

public void setTreatConsecutiveDelimitersAsOne(boolean value)

public boolean getTreatQuotePrefixAsValue() / 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.QuotePrefix will be set as true for the cell.

public void setTreatQuotePrefixAsValue(boolean value)

public boolean getExtendToNextSheet() / 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;

public void setExtendToNextSheet(boolean value)

public com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.Encoding value)

Gets and sets the default encoding. Only applies for csv file.

public void setEncoding(com.aspose.cells.Encoding value)

public int getLoadStyleStrategy() / public void setLoadStyleStrategy(int value)

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.

public void setLoadStyleStrategy(int value)

public boolean getConvertNumericData() / public void setConvertNumericData(boolean value)

Gets or sets a value that indicates whether the string in text file is converted to numeric data.

public void setConvertNumericData(boolean value)

public boolean getConvertDateTimeData() / public void setConvertDateTimeData(boolean value)

Gets or sets a value that indicates whether the string in text file is converted to date data.

public void setConvertDateTimeData(boolean value)

public boolean getKeepPrecision() / public void setKeepPrecision(boolean value)

Indicates whether not parsing a string value if the length is 15.

public void setKeepPrecision(boolean value)

public int getLoadFormat()

Gets the load format. The value of the property is LoadFormat integer constant.

public java.lang.String getPassword() / public void setPassword(java.lang.String value)

Gets and set the password of the workbook.

public void setPassword(java.lang.String value)

public boolean getParsingFormulaOnOpen() / 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.

public void setParsingFormulaOnOpen(boolean value)

public boolean getParsingPivotCachedRecords() / 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

public void setParsingPivotCachedRecords(boolean value)

public int getLanguageCode() / public void setLanguageCode(int value)

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.

public void setLanguageCode(int value)

public int getRegion() / public void setRegion(int value)

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.

public void setRegion(int value)

public java.util.Locale getLocale() / public void setLocale(java.util.Locale value)

Gets and sets the Locale used for workbook at the time the file was loaded.

public void setLocale(java.util.Locale value)

public DefaultStyleSettings getDefaultStyleSettings()

Gets the default style settings for initializing styles of the workbook

public java.lang.String getStandardFont() / public void setStandardFont(java.lang.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.

public void setStandardFont(java.lang.String value)

public double getStandardFontSize() / 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.

public void setStandardFontSize(double value)

public AbstractInterruptMonitor getInterruptMonitor() / public void setInterruptMonitor(AbstractInterruptMonitor value)

Gets and sets the interrupt monitor.

public void setInterruptMonitor(AbstractInterruptMonitor value)

public boolean getIgnoreNotPrinted() / public void setIgnoreNotPrinted(boolean value)

Ignore the data which are not printed if directly printing the file

Only for xlsx file.

public void setIgnoreNotPrinted(boolean value)

public boolean getCheckDataValid() / public void setCheckDataValid(boolean value)

Check whether data is valid in the template file.

public void setCheckDataValid(boolean value)

public boolean getCheckExcelRestriction() / 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.

public void setCheckExcelRestriction(boolean value)

public boolean getKeepUnparsedData() / 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,

public void setKeepUnparsedData(boolean value)

public LoadFilter getLoadFilter() / public void setLoadFilter(LoadFilter value)

The filter to denote how to load data.

public void setLoadFilter(LoadFilter value)

public LightCellsDataHandler getLightCellsDataHandler() / public void setLightCellsDataHandler(LightCellsDataHandler value)

The data handler for processing cells data when reading template file.

public void setLightCellsDataHandler(LightCellsDataHandler value)

public int getMemorySetting() / public void setMemorySetting(int value)

Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.

public void setMemorySetting(int value)

public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)

Gets or sets warning callback.

public void setWarningCallback(IWarningCallback value)

public AutoFitterOptions getAutoFitterOptions() / public void setAutoFitterOptions(AutoFitterOptions value)

Gets and sets the auto fitter options

Only for xlsx ,spreadsheetML file now.

public void setAutoFitterOptions(AutoFitterOptions value)

public boolean getAutoFilter() / 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.

public void setAutoFilter(boolean value)

public IndividualFontConfigs getFontConfigs() / public void setFontConfigs(IndividualFontConfigs value)

Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>

public void setFontConfigs(IndividualFontConfigs value)

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:

type - A PaperSizeType value. The default paper size.