aspose.cells

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
`function`	`getAutoFilter()`
`function`	`setAutoFilter(value)`
	Indicates whether auto filtering the data when loading the files.
`function`	`getAutoFitterOptions()`
`function`	`setAutoFitterOptions(value)`
	Gets and sets the auto fitter options
`function`	`getCheckDataValid()`
`function`	`setCheckDataValid(value)`
	Check whether data is valid in the template file.
`function`	`getCheckExcelRestriction()`
`function`	`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.
`function`	`getConvertDateTimeData()`
`function`	`setConvertDateTimeData(value)`
	Gets or sets a value that indicates whether the string in text file is converted to date data.
`function`	`getConvertNumericData()`
`function`	`setConvertNumericData(value)`
	Gets or sets a value that indicates whether the string in text file is converted to numeric data.
`function`	`getDefaultStyleSettings()`
	Gets the default style settings for initializing styles of the workbook
`function`	`getEncoding()`
`function`	`setEncoding(value)`
	Gets and sets the default encoding. Only applies for csv file.
`function`	`getExtendToNextSheet()`
`function`	`setExtendToNextSheet(value)`
	Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.
`function`	`getFontConfigs()`
`function`	`setFontConfigs(value)`
	Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
`function`	`hasFormula()`
`function`	`setHasFormula(value)`
	Indicates whether the text is formula if it starts with "=".
`function`	`hasTextQualifier()`
`function`	`setHasTextQualifier(value)`
	Whether there is text qualifier for cell value. Default is true.
`function`	`getHeaderColumnsCount()`
`function`	`setHeaderColumnsCount(value)`
	The count of header columns to be repeated for extended sheets.
`function`	`getHeaderRowsCount()`
`function`	`setHeaderRowsCount(value)`
	The count of header rows to be repeated for extended sheets.
`function`	`getIgnoreNotPrinted()`
`function`	`setIgnoreNotPrinted(value)`
	Ignore the data which are not printed if directly printing the file
`function`	`getIgnoreUselessShapes()`
`function`	`setIgnoreUselessShapes(value)`
	Indicates whether ignoring useless shapes.
`function`	`getInterruptMonitor()`
`function`	`setInterruptMonitor(value)`
	Gets and sets the interrupt monitor.
`function`	`isMultiEncoded()`
`function`	`setMultiEncoded(value)`
	True means that the file contains several encoding.
`function`	`getKeepPrecision()`
`function`	`setKeepPrecision(value)`
	Indicates whether not parsing a string value if the length is 15.
`function`	`getKeepUnparsedData()`
`function`	`setKeepUnparsedData(value)`
	Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
`function`	`getLanguageCode()`
`function`	`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.
`function`	`getLightCellsDataHandler()`
`function`	`setLightCellsDataHandler(value)`
	The data handler for processing cells data when reading template file.
`function`	`getLoadFilter()`
`function`	`setLoadFilter(value)`
	The filter to denote how to load data.
`function`	`getLoadFormat()`
	Gets the load format. The value of the property is LoadFormat integer constant.
`function`	`getLoadStyleStrategy()`
`function`	`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.
`function`	`getLocale()`
`function`	`setLocale(value)`
	Gets and sets the Locale used for workbook at the time the file was loaded.
`function`	`getMaxColumnCount()`
`function`	`setMaxColumnCount(value)`
	The maximum count of columns to be imported for one sheet.
`function`	`getMaxRowCount()`
`function`	`setMaxRowCount(value)`
	The maximum count of rows to be imported for one sheet.
`function`	`getMemorySetting()`
`function`	`setMemorySetting(value)`
	Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
`function`	`getParsingFormulaOnOpen()`
`function`	`setParsingFormulaOnOpen(value)`
	Indicates whether parsing the formula when reading the file.
`function`	`getParsingPivotCachedRecords()`
`function`	`setParsingPivotCachedRecords(value)`
	Indicates whether parsing pivot cached records when loading the file. The default value is false.
`function`	`getPassword()`
`function`	`setPassword(value)`
	Gets and set the password of the workbook.
`function`	`getPreferredParsers()`
`function`	`setPreferredParsers(value)`
	Gets and sets preferred value parsers for loading text file.
`function`	`getPreservePaddingSpacesInFormula()`
`function`	`setPreservePaddingSpacesInFormula(value)`
	Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
`function`	`getRegion()`
`function`	`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.
`function`	`getSeparator()`
`function`	`setSeparator(value)`
	Gets and sets character separator of text file.
`function`	`getSeparatorString()`
`function`	`setSeparatorString(value)`
	Gets and sets a string value as separator.
`function`	`getStandardFont()`
`function`	`setStandardFont(value)`
	Sets the default standard font name
`function`	`getStandardFontSize()`
`function`	`setStandardFontSize(value)`
	Sets the default standard font size.
`function`	`getTextQualifier()`
`function`	`setTextQualifier(value)`
	Specifies the text qualifier for cell values. Default qualifier is '"'.
`function`	`getTreatConsecutiveDelimitersAsOne()`
`function`	`setTreatConsecutiveDelimitersAsOne(value)`
	Whether consecutive delimiters should be treated as one.
`function`	`getTreatQuotePrefixAsValue()`
`function`	`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
`function`	`setPaperSize(type)`
`function`	Sets the default print paper size from default printer's setting.

- Constructor Detail
  - TxtLoadOptions
```
function TxtLoadOptions()
```
    Creates the options for loading text file.
    The default load file type is CSV .
  - TxtLoadOptions
```
function TxtLoadOptions(loadFormat)
```
    Creates the options for loading text file.
    Parameters:
    loadFormat: Number - A LoadFormat value. The loading format
- Property Getters/Setters Detail
  - getSeparator/setSeparator : char
```
function getSeparator() / function setSeparator(value)
```
    Gets and sets character separator of text file.
  - getSeparatorString/setSeparatorString : String
```
function getSeparatorString() / function setSeparatorString(value)
```
    Gets and sets a string value as separator.
  - isMultiEncoded/setMultiEncoded : boolean
```
function isMultiEncoded() / function setMultiEncoded(value)
```
    True means that the file contains several encoding.
  - getPreferredParsers/setPreferredParsers : ICustomParser[]
```
function getPreferredParsers() / function 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
```
function hasFormula() / function setHasFormula(value)
```
    Indicates whether the text is formula if it starts with "=".
  - hasTextQualifier/setHasTextQualifier : boolean
```
function hasTextQualifier() / function setHasTextQualifier(value)
```
    Whether there is text qualifier for cell value. Default is true.
  - getTextQualifier/setTextQualifier : char
```
function getTextQualifier() / function setTextQualifier(value)
```
    Specifies the text qualifier for cell values. Default qualifier is '"'.
    When setting this property, HasTextQualifier will become true automatically.
  - getTreatConsecutiveDelimitersAsOne/setTreatConsecutiveDelimitersAsOne : boolean
```
function getTreatConsecutiveDelimitersAsOne() / function setTreatConsecutiveDelimitersAsOne(value)
```
    Whether consecutive delimiters should be treated as one.
  - getTreatQuotePrefixAsValue/setTreatQuotePrefixAsValue : boolean
```
function getTreatQuotePrefixAsValue() / function 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
```
function getExtendToNextSheet() / function setExtendToNextSheet(value)
```
    Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.
    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/setHeaderRowsCount : Number
```
function getHeaderRowsCount() / function setHeaderRowsCount(value)
```
    The count of header rows to be repeated for extended sheets.
    The header rows specified by this property will be duplicated for those extended sheets. This property only takes effect when ExtendToNextSheet is true.
  - getHeaderColumnsCount/setHeaderColumnsCount : Number
```
function getHeaderColumnsCount() / function setHeaderColumnsCount(value)
```
    The count of header columns to be repeated for extended sheets.
    The header columns specified by this property will be duplicated for those extended sheets. This property only takes effect when ExtendToNextSheet is true.
  - getMaxRowCount/setMaxRowCount : Number
```
function getMaxRowCount() / function setMaxRowCount(value)
```
    The maximum count of rows to be imported for one sheet.
    Those rows exceeding this limit will be ignored or extended to next sheet according to ExtendToNextSheet. This count includes the header rows(HeaderRowsCount). 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/setMaxColumnCount : Number
```
function getMaxColumnCount() / function setMaxColumnCount(value)
```
    The maximum count of columns to be imported for one sheet.
    Those columns exceeding this limit will be ignored or extended to next sheet according to ExtendToNextSheet. This count includes the header columns(HeaderColumnsCount). 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.
  - getEncoding/setEncoding : Encoding
```
function getEncoding() / function setEncoding(value)
```
    Gets and sets the default encoding. Only applies for csv file.
  - getLoadStyleStrategy/setLoadStyleStrategy : Number
```
function getLoadStyleStrategy() / function 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
```
function getConvertNumericData() / function setConvertNumericData(value)
```
    Gets or sets a value that indicates whether the string in text file is converted to numeric data.
  - getConvertDateTimeData/setConvertDateTimeData : boolean
```
function getConvertDateTimeData() / function setConvertDateTimeData(value)
```
    Gets or sets a value that indicates whether the string in text file is converted to date data.
  - getKeepPrecision/setKeepPrecision : boolean
```
function getKeepPrecision() / function setKeepPrecision(value)
```
    Indicates whether not parsing a string value if the length is 15.
  - getLoadFormat : Number
```
function getLoadFormat()
```
    Gets the load format. The value of the property is LoadFormat integer constant.
  - getPassword/setPassword : String
```
function getPassword() / function setPassword(value)
```
    Gets and set the password of the workbook.
  - getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean
```
function getParsingFormulaOnOpen() / function 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
```
function getParsingPivotCachedRecords() / function 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 : Number
```
function getLanguageCode() / function 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 : Number
```
function getRegion() / function 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
```
function getLocale() / function setLocale(value)
```
    Gets and sets the Locale used for workbook at the time the file was loaded.
  - getDefaultStyleSettings : DefaultStyleSettings
```
function getDefaultStyleSettings()
```
    Gets the default style settings for initializing styles of the workbook
  - getStandardFont/setStandardFont : String
```
function getStandardFont() / function 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 : Number
```
function getStandardFontSize() / function 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
```
function getInterruptMonitor() / function setInterruptMonitor(value)
```
    Gets and sets the interrupt monitor.
  - getIgnoreNotPrinted/setIgnoreNotPrinted : boolean
```
function getIgnoreNotPrinted() / function setIgnoreNotPrinted(value)
```
    Ignore the data which are not printed if directly printing the file
    Only for xlsx file.
  - getCheckDataValid/setCheckDataValid : boolean
```
function getCheckDataValid() / function setCheckDataValid(value)
```
    Check whether data is valid in the template file.
  - getCheckExcelRestriction/setCheckExcelRestriction : boolean
```
function getCheckExcelRestriction() / function 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
```
function getKeepUnparsedData() / function 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
```
function getLoadFilter() / function setLoadFilter(value)
```
    The filter to denote how to load data.
  - getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler
```
function getLightCellsDataHandler() / function setLightCellsDataHandler(value)
```
    The data handler for processing cells data when reading template file.
  - getMemorySetting/setMemorySetting : Number
```
function getMemorySetting() / function setMemorySetting(value)
```
    Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
  - getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions
```
function getAutoFitterOptions() / function setAutoFitterOptions(value)
```
    Gets and sets the auto fitter options
    Only for xlsx ,spreadsheetML file now.
  - getAutoFilter/setAutoFilter : boolean
```
function getAutoFilter() / function 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
```
function getFontConfigs() / function setFontConfigs(value)
```
    Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
  - getIgnoreUselessShapes/setIgnoreUselessShapes : boolean
```
function getIgnoreUselessShapes() / function setIgnoreUselessShapes(value)
```
    Indicates whether ignoring useless shapes.
    Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.
  - getPreservePaddingSpacesInFormula/setPreservePaddingSpacesInFormula : boolean
```
function getPreservePaddingSpacesInFormula() / function setPreservePaddingSpacesInFormula(value)
```
    Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
    After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.
- Method Detail
  - setPaperSize
```
function 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: Number - A PaperSizeType value. The default paper size.

aspose.cells

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

getHeaderRowsCount/setHeaderRowsCount : Number

getHeaderColumnsCount/setHeaderColumnsCount : Number

getMaxRowCount/setMaxRowCount : Number

getMaxColumnCount/setMaxColumnCount : Number

getEncoding/setEncoding : Encoding

getLoadStyleStrategy/setLoadStyleStrategy : Number

getConvertNumericData/setConvertNumericData : boolean

getConvertDateTimeData/setConvertDateTimeData : boolean

getKeepPrecision/setKeepPrecision : boolean

getLoadFormat : Number

getPassword/setPassword : String

getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean

getParsingPivotCachedRecords/setParsingPivotCachedRecords : boolean

getLanguageCode/setLanguageCode : Number

getRegion/setRegion : Number

getLocale/setLocale : Locale

getDefaultStyleSettings : DefaultStyleSettings

getStandardFont/setStandardFont : String

getStandardFontSize/setStandardFontSize : Number

getInterruptMonitor/setInterruptMonitor : AbstractInterruptMonitor

getIgnoreNotPrinted/setIgnoreNotPrinted : boolean

getCheckDataValid/setCheckDataValid : boolean

getCheckExcelRestriction/setCheckExcelRestriction : boolean

getKeepUnparsedData/setKeepUnparsedData : boolean

getLoadFilter/setLoadFilter : LoadFilter

getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler

getMemorySetting/setMemorySetting : Number

getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions

getAutoFilter/setAutoFilter : boolean

getFontConfigs/setFontConfigs : IndividualFontConfigs

getIgnoreUselessShapes/setIgnoreUselessShapes : boolean

getPreservePaddingSpacesInFormula/setPreservePaddingSpacesInFormula : boolean

Method Detail

setPaperSize