com.aspose.cells

Class TxtLoadOptions

java.lang.Object

com.aspose.cells.LoadOptions

com.aspose.cells.AbstractTextLoadOptions

com.aspose.cells.TxtLoadOptions

public class TxtLoadOptions
extends AbstractTextLoadOptions

Represents the options for loading text file.

Constructor Summary

Constructors

Constructor and Description
TxtLoadOptions() Creates the options for loading text file.
TxtLoadOptions(int loadFormat) Creates the options for loading text file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getExtendToNextSheet() Whether extends data to next sheet when the rows or columns of data exceed limit.
int	getHeaderColumnsCount() The count of header columns to be repeated for extended sheets.
int	getHeaderRowsCount() The count of header rows to be repeated for extended sheets.
int	getMaxColumnCount() The maximum count of columns to be imported for one sheet.
int	getMaxRowCount() The maximum count of rows to be imported for one sheet.
ICustomParser[]	getPreferredParsers() Gets preferred value parsers for loading text file.
char	getSeparator() Gets character separator of text file.
java.lang.String	getSeparatorString() Gets a string value as separator.
char	getTextQualifier() Specifies the text qualifier for cell values.
boolean	getTreatConsecutiveDelimitersAsOne() Whether consecutive delimiters should be treated as one.
boolean	getTreatQuotePrefixAsValue() Indicates whether the leading single quote sign should be taken as part of the value of one cell.
boolean	hasFormula() Indicates whether the text is formula if it starts with "=".
boolean	hasTextQualifier() Whether there is text qualifier for cell value.
boolean	isMultiEncoded() True means that the file contains several encoding.
void	setExtendToNextSheet(boolean value) Whether extends data to next sheet when the rows or columns of data exceed limit.
void	setHasFormula(boolean value) Indicates whether the text is formula if it starts with "=".
void	setHasTextQualifier(boolean value) Whether there is text qualifier for cell value.
void	setHeaderColumnsCount(int value) The count of header columns to be repeated for extended sheets.
void	setHeaderRowsCount(int value) The count of header rows to be repeated for extended sheets.
void	setMaxColumnCount(int value) The maximum count of columns to be imported for one sheet.
void	setMaxRowCount(int value) The maximum count of rows to be imported for one sheet.
void	setMultiEncoded(boolean value) True means that the file contains several encoding.
void	setPreferredParsers(ICustomParser[] value) Sets preferred value parsers for loading text file.
void	setSeparator(char value) Sets character separator of text file.
void	setSeparatorString(java.lang.String value) Sets a string value as separator.
void	setTextQualifier(char value) Specifies the text qualifier for cell values.
void	setTreatConsecutiveDelimitersAsOne(boolean value) Whether consecutive delimiters should be treated as one.
void	setTreatQuotePrefixAsValue(boolean value) Indicates whether the leading single quote sign should be taken as part of the value of one cell.

Methods inherited from class com.aspose.cells.AbstractTextLoadOptions

copy, getConvertDateTimeData, getConvertNumericData, getEncoding, getKeepPrecision, getLoadStyleStrategy, setConvertDateTimeData, setConvertNumericData, setEncoding, setKeepPrecision, setLoadStyleStrategy

Methods inherited from class com.aspose.cells.LoadOptions

getAutoFilter, getAutoFitterOptions, getCheckDataValid, getCheckExcelRestriction, getDefaultStyleSettings, getFontConfigs, getIgnoreNotPrinted, getIgnoreUselessShapes, getInterruptMonitor, getKeepUnparsedData, getLanguageCode, getLightCellsDataHandler, getLoadFilter, getLoadFormat, getLocale, getMemorySetting, getParsingFormulaOnOpen, getParsingPivotCachedRecords, getPassword, getPreservePaddingSpacesInFormula, getRegion, getStandardFont, getStandardFontSize, getWarningCallback, setAutoFilter, setAutoFitterOptions, setCheckDataValid, setCheckExcelRestriction, setFontConfigs, setIgnoreNotPrinted, setIgnoreUselessShapes, setInterruptMonitor, setKeepUnparsedData, setLanguageCode, setLightCellsDataHandler, setLoadFilter, setLocale, setMemorySetting, setPaperSize, setParsingFormulaOnOpen, setParsingPivotCachedRecords, setPassword, setPreservePaddingSpacesInFormula, setRegion, setStandardFont, setStandardFontSize, setWarningCallback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TxtLoadOptions

public TxtLoadOptions()

Creates the options for loading text file.

Remarks

The default load file type is CSV .

TxtLoadOptions

public TxtLoadOptions(int loadFormat)

Creates the options for loading text file.

Parameters:

loadFormat - LoadFormat. The loading format

Method Detail

getSeparator

public char getSeparator()

Gets character separator of text file.

setSeparator

public void setSeparator(char value)

Sets character separator of text file.

getSeparatorString

public java.lang.String getSeparatorString()

Gets a string value as separator.

setSeparatorString

public void setSeparatorString(java.lang.String value)

Sets a string value as separator.

isMultiEncoded

public boolean isMultiEncoded()

True means that the file contains several encoding.

setMultiEncoded

public void setMultiEncoded(boolean value)

True means that the file contains several encoding.

getPreferredParsers

public ICustomParser[] getPreferredParsers()

Gets preferred value parsers for loading text file.

Remarks

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.

setPreferredParsers

public void setPreferredParsers(ICustomParser[] value)

Sets preferred value parsers for loading text file.

Remarks

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.

hasFormula

public boolean hasFormula()

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

setHasFormula

public void setHasFormula(boolean value)

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

hasTextQualifier

public boolean hasTextQualifier()

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

setHasTextQualifier

public void setHasTextQualifier(boolean value)

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

getTextQualifier

public char getTextQualifier()

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

Remarks

When setting this property, hasTextQualifier() will become true automatically.

setTextQualifier

public void setTextQualifier(char value)

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

Remarks

When setting this property, hasTextQualifier() will become true automatically.

getTreatConsecutiveDelimitersAsOne

public boolean getTreatConsecutiveDelimitersAsOne()

Whether consecutive delimiters should be treated as one.

setTreatConsecutiveDelimitersAsOne

public void setTreatConsecutiveDelimitersAsOne(boolean value)

Whether consecutive delimiters should be treated as one.

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.

setTreatQuotePrefixAsValue

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.

getExtendToNextSheet

public boolean getExtendToNextSheet()

Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.

Remarks

If this property is true, extra data will be put into 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 exceeding limit will be ignored.

setExtendToNextSheet

public void setExtendToNextSheet(boolean value)

Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.

Remarks

If this property is true, extra data will be put into 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 exceeding limit will be ignored.

getHeaderRowsCount

public int getHeaderRowsCount()

The count of header rows to be repeated for extended sheets.

Remarks

The header rows specified by this property will be duplicated for those extended sheets. This property only takes effect when getExtendToNextSheet() is true.

setHeaderRowsCount

public void setHeaderRowsCount(int value)

The count of header rows to be repeated for extended sheets.

Remarks

The header rows specified by this property will be duplicated for those extended sheets. This property only takes effect when getExtendToNextSheet() is true.

getHeaderColumnsCount

public int getHeaderColumnsCount()

The count of header columns to be repeated for extended sheets.

Remarks

The header columns specified by this property will be duplicated for those extended sheets. This property only takes effect when getExtendToNextSheet() is true.

setHeaderColumnsCount

public void setHeaderColumnsCount(int value)

The count of header columns to be repeated for extended sheets.

Remarks

The header columns specified by this property will be duplicated for those extended sheets. This property only takes effect when getExtendToNextSheet() is true.

getMaxRowCount

public int getMaxRowCount()

The maximum count of rows to be imported for one sheet.

Remarks

Those rows exceeding this limit will be ignored or extended to next sheet according to getExtendToNextSheet(). This count includes the header rows(getHeaderRowsCount()). The maximum allowed value of it is the row limit of corresponding file format, such as for xlsx file it 1048576. If this property has not been specified or the specified value is not positive, then the maximum limit will be used too.

setMaxRowCount

public void setMaxRowCount(int value)

The maximum count of rows to be imported for one sheet.

Remarks

Those rows exceeding this limit will be ignored or extended to next sheet according to getExtendToNextSheet(). This count includes the header rows(getHeaderRowsCount()). The maximum allowed value of it is the row limit of corresponding file format, such as for xlsx file it 1048576. If this property has not been specified or the specified value is not positive, then the maximum limit will be used too.

getMaxColumnCount

public int getMaxColumnCount()

The maximum count of columns to be imported for one sheet.

Remarks

Those columns exceeding this limit will be ignored or extended to next sheet according to getExtendToNextSheet(). This count includes the header columns(getHeaderColumnsCount()). The maximum value of it is the column limit of corresponding file format, such as for xlsx file it 16384. If this property has not been specified or the specified value is not positive, then the maximum limit will be used too.

setMaxColumnCount

public void setMaxColumnCount(int value)

The maximum count of columns to be imported for one sheet.

Remarks

Those columns exceeding this limit will be ignored or extended to next sheet according to getExtendToNextSheet(). This count includes the header columns(getHeaderColumnsCount()). The maximum value of it is the column limit of corresponding file format, such as for xlsx file it 16384. If this property has not been specified or the specified value is not positive, then the maximum limit will be used too.