asposecells.api

Classes

Constants

Class TxtLoadOptions

Represents the options for loading text file.

Constructor Summary
`TxtLoadOptions()` Creates the options for loading text file.
`TxtLoadOptions(loadFormat)` Creates the options for loading text file.

Property Getters/Setters Summary
`method`	`getAutoFilter()`
`method`	`setAutoFilter(value)`
	Indicates whether auto filtering the data when loading the files.
`method`	`getAutoFitterOptions()`
`method`	`setAutoFitterOptions(value)`
	Gets and sets the auto fitter options
`method`	`getCheckDataValid()`
`method`	`setCheckDataValid(value)`
	Check whether data is valid in the template file.
`method`	`getCheckExcelRestriction()`
`method`	`setCheckExcelRestriction(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.
`method`	`getConvertDateTimeData()`
`method`	`setConvertDateTimeData(value)`
	Gets or sets a value that indicates whether the string in text file is converted to date data.
`method`	`getConvertNumericData()`
`method`	`setConvertNumericData(value)`
	Gets or sets a value that indicates whether the string in text file is converted to numeric data.
`method`	`getDefaultStyleSettings()`
	Gets the default style settings for initializing styles of the workbook
`method`	`getEncoding()`
`method`	`setEncoding(value)`
	Gets and sets the default encoding. Only applies for csv file.
`method`	`getExtendToNextSheet()`
`method`	`setExtendToNextSheet(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;
`method`	`getFontConfigs()`
`method`	`setFontConfigs(value)`
	Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
`method`	`hasFormula()`
`method`	`setHasFormula(value)`
	Indicates whether the text is formula if it starts with "=".
`method`	`hasTextQualifier()`
`method`	`setHasTextQualifier(value)`
	Whether there is text qualifier for cell value. Default is true.
`method`	`getIgnoreNotPrinted()`
`method`	`setIgnoreNotPrinted(value)`
	Ignore the data which are not printed if directly printing the file
`method`	`getInterruptMonitor()`
`method`	`setInterruptMonitor(value)`
	Gets and sets the interrupt monitor.
`method`	`isMultiEncoded()`
`method`	`setMultiEncoded(value)`
	True means that the file contains several encoding.
`method`	`getKeepPrecision()`
`method`	`setKeepPrecision(value)`
	Indicates whether not parsing a string value if the length is 15.
`method`	`getKeepUnparsedData()`
`method`	`setKeepUnparsedData(value)`
	Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
`method`	`getLanguageCode()`
`method`	`setLanguageCode(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.
`method`	`getLightCellsDataHandler()`
`method`	`setLightCellsDataHandler(value)`
	The data handler for processing cells data when reading template file.
`method`	`getLoadFilter()`
`method`	`setLoadFilter(value)`
	The filter to denote how to load data.
`method`	`getLoadFormat()`
	Gets the load format. The value of the property is LoadFormat integer constant.
`method`	`getLoadStyleStrategy()`
`method`	`setLoadStyleStrategy(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.
`method`	`getLocale()`
`method`	`setLocale(value)`
	Gets and sets the Locale used for workbook at the time the file was loaded.
`method`	`getMemorySetting()`
`method`	`setMemorySetting(value)`
	Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
`method`	`getParsingFormulaOnOpen()`
`method`	`setParsingFormulaOnOpen(value)`
	Indicates whether parsing the formula when reading the file.
`method`	`getParsingPivotCachedRecords()`
`method`	`setParsingPivotCachedRecords(value)`
	Indicates whether parsing pivot cached records when loading the file. The default value is false.
`method`	`getPassword()`
`method`	`setPassword(value)`
	Gets and set the password of the workbook.
`method`	`getPreferredParsers()`
`method`	`setPreferredParsers(value)`
	Gets and sets preferred value parsers for loading text file.
`method`	`getRegion()`
`method`	`setRegion(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.
`method`	`getSeparator()`
`method`	`setSeparator(value)`
	Gets and sets character separator of text file.
`method`	`getSeparatorString()`
`method`	`setSeparatorString(value)`
	Gets and sets a string value as separator.
`method`	`getStandardFont()`
`method`	`setStandardFont(value)`
	Sets the default standard font name
`method`	`getStandardFontSize()`
`method`	`setStandardFontSize(value)`
	Sets the default standard font size.
`method`	`getTextQualifier()`
`method`	`setTextQualifier(value)`
	Specifies the text qualifier for cell values. Default qualifier is '"'.
`method`	`getTreatConsecutiveDelimitersAsOne()`
`method`	`setTreatConsecutiveDelimitersAsOne(value)`
	Whether consecutive delimiters should be treated as one.
`method`	`getTreatQuotePrefixAsValue()`
`method`	`setTreatQuotePrefixAsValue(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.

Method Summary
`method`	`setPaperSize(type)`
`method`	Sets the default print paper size from default printer's setting.

- Constructor Detail
  - TxtLoadOptions
```
TxtLoadOptions()
```
    Creates the options for loading text file.
    The default load file type is CSV .
  - TxtLoadOptions
```
TxtLoadOptions(loadFormat)
```
    Creates the options for loading text file.
    Parameters:
    loadFormat: int - A LoadFormat value. The loading format
- Property Getters/Setters Detail
  - getSeparator/setSeparator : char
```
char getSeparator() / setSeparator(value)
```
    Gets and sets character separator of text file.
  - getSeparatorString/setSeparatorString : String
```
String getSeparatorString() / setSeparatorString(value)
```
    Gets and sets a string value as separator.
  - isMultiEncoded/setMultiEncoded : boolean
```
boolean isMultiEncoded() / setMultiEncoded(value)
```
    True means that the file contains several encoding.
  - getPreferredParsers/setPreferredParsers : ICustomParser[]
```
ICustomParser[] getPreferredParsers() / setPreferredParsers(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.
  - hasFormula/setHasFormula : boolean
```
boolean hasFormula() / setHasFormula(value)
```
    Indicates whether the text is formula if it starts with "=".
  - hasTextQualifier/setHasTextQualifier : boolean
```
boolean hasTextQualifier() / setHasTextQualifier(value)
```
    Whether there is text qualifier for cell value. Default is true.
  - getTextQualifier/setTextQualifier : char
```
char getTextQualifier() / setTextQualifier(value)
```
    Specifies the text qualifier for cell values. Default qualifier is '"'.
    When setting this property, HasTextQualifier will become true automatically.
  - getTreatConsecutiveDelimitersAsOne/setTreatConsecutiveDelimitersAsOne : boolean
```
boolean getTreatConsecutiveDelimitersAsOne() / setTreatConsecutiveDelimitersAsOne(value)
```
    Whether consecutive delimiters should be treated as one.
  - getTreatQuotePrefixAsValue/setTreatQuotePrefixAsValue : boolean
```
boolean getTreatQuotePrefixAsValue() / setTreatQuotePrefixAsValue(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.
  - getExtendToNextSheet/setExtendToNextSheet : boolean
```
boolean getExtendToNextSheet() / setExtendToNextSheet(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;
  - getEncoding/setEncoding : Encoding
```
Encoding getEncoding() / setEncoding(value)
```
    Gets and sets the default encoding. Only applies for csv file.
  - getLoadStyleStrategy/setLoadStyleStrategy : int
```
int getLoadStyleStrategy() / setLoadStyleStrategy(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.
  - getConvertNumericData/setConvertNumericData : boolean
```
boolean getConvertNumericData() / setConvertNumericData(value)
```
    Gets or sets a value that indicates whether the string in text file is converted to numeric data.
  - getConvertDateTimeData/setConvertDateTimeData : boolean
```
boolean getConvertDateTimeData() / setConvertDateTimeData(value)
```
    Gets or sets a value that indicates whether the string in text file is converted to date data.
  - getKeepPrecision/setKeepPrecision : boolean
```
boolean getKeepPrecision() / setKeepPrecision(value)
```
    Indicates whether not parsing a string value if the length is 15.
  - getLoadFormat : int
```
int getLoadFormat()
```
    Gets the load format. The value of the property is LoadFormat integer constant.
  - getPassword/setPassword : String
```
String getPassword() / setPassword(value)
```
    Gets and set the password of the workbook.
  - getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean
```
boolean getParsingFormulaOnOpen() / setParsingFormulaOnOpen(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.
  - getParsingPivotCachedRecords/setParsingPivotCachedRecords : boolean
```
boolean getParsingPivotCachedRecords() / setParsingPivotCachedRecords(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
  - getLanguageCode/setLanguageCode : int
```
int getLanguageCode() / setLanguageCode(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.
  - getRegion/setRegion : int
```
int getRegion() / setRegion(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.
  - getLocale/setLocale : Locale
```
Locale getLocale() / setLocale(value)
```
    Gets and sets the Locale used for workbook at the time the file was loaded.
  - getDefaultStyleSettings : DefaultStyleSettings
```
DefaultStyleSettings getDefaultStyleSettings()
```
    Gets the default style settings for initializing styles of the workbook
  - getStandardFont/setStandardFont : String
```
String getStandardFont() / setStandardFont(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.
  - getStandardFontSize/setStandardFontSize : float
```
float getStandardFontSize() / setStandardFontSize(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.
  - getInterruptMonitor/setInterruptMonitor : AbstractInterruptMonitor
```
AbstractInterruptMonitor getInterruptMonitor() / setInterruptMonitor(value)
```
    Gets and sets the interrupt monitor.
  - getIgnoreNotPrinted/setIgnoreNotPrinted : boolean
```
boolean getIgnoreNotPrinted() / setIgnoreNotPrinted(value)
```
    Ignore the data which are not printed if directly printing the file
    Only for xlsx file.
  - getCheckDataValid/setCheckDataValid : boolean
```
boolean getCheckDataValid() / setCheckDataValid(value)
```
    Check whether data is valid in the template file.
  - getCheckExcelRestriction/setCheckExcelRestriction : boolean
```
boolean getCheckExcelRestriction() / setCheckExcelRestriction(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.
  - getKeepUnparsedData/setKeepUnparsedData : boolean
```
boolean getKeepUnparsedData() / setKeepUnparsedData(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,
  - getLoadFilter/setLoadFilter : LoadFilter
```
LoadFilter getLoadFilter() / setLoadFilter(value)
```
    The filter to denote how to load data.
  - getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler
```
LightCellsDataHandler getLightCellsDataHandler() / setLightCellsDataHandler(value)
```
    The data handler for processing cells data when reading template file.
  - getMemorySetting/setMemorySetting : int
```
int getMemorySetting() / setMemorySetting(value)
```
    Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
  - getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions
```
AutoFitterOptions getAutoFitterOptions() / setAutoFitterOptions(value)
```
    Gets and sets the auto fitter options
    Only for xlsx ,spreadsheetML file now.
  - getAutoFilter/setAutoFilter : boolean
```
boolean getAutoFilter() / setAutoFilter(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.
  - getFontConfigs/setFontConfigs : IndividualFontConfigs
```
IndividualFontConfigs getFontConfigs() / setFontConfigs(value)
```
    Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
- Method Detail
  - setPaperSize
```
 setPaperSize(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: int - A PaperSizeType value. The default paper size.

asposecells.api

Classes

Constants

Class TxtLoadOptions

Constructor Detail

TxtLoadOptions

TxtLoadOptions

Property Getters/Setters Detail

getSeparator/setSeparator : char

getSeparatorString/setSeparatorString : String

isMultiEncoded/setMultiEncoded : boolean

getPreferredParsers/setPreferredParsers : ICustomParser[]

hasFormula/setHasFormula : boolean

hasTextQualifier/setHasTextQualifier : boolean

getTextQualifier/setTextQualifier : char

getTreatConsecutiveDelimitersAsOne/setTreatConsecutiveDelimitersAsOne : boolean

getTreatQuotePrefixAsValue/setTreatQuotePrefixAsValue : boolean

getExtendToNextSheet/setExtendToNextSheet : boolean

getEncoding/setEncoding : Encoding

getLoadStyleStrategy/setLoadStyleStrategy : int

getConvertNumericData/setConvertNumericData : boolean

getConvertDateTimeData/setConvertDateTimeData : boolean

getKeepPrecision/setKeepPrecision : boolean

getLoadFormat : int

getPassword/setPassword : String

getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean

getParsingPivotCachedRecords/setParsingPivotCachedRecords : boolean

getLanguageCode/setLanguageCode : int

getRegion/setRegion : int

getLocale/setLocale : Locale

getDefaultStyleSettings : DefaultStyleSettings

getStandardFont/setStandardFont : String

getStandardFontSize/setStandardFontSize : float

getInterruptMonitor/setInterruptMonitor : AbstractInterruptMonitor

getIgnoreNotPrinted/setIgnoreNotPrinted : boolean

getCheckDataValid/setCheckDataValid : boolean

getCheckExcelRestriction/setCheckExcelRestriction : boolean

getKeepUnparsedData/setKeepUnparsedData : boolean

getLoadFilter/setLoadFilter : LoadFilter

getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler

getMemorySetting/setMemorySetting : int

getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions

getAutoFilter/setAutoFilter : boolean

getFontConfigs/setFontConfigs : IndividualFontConfigs

Method Detail

setPaperSize