TxtLoadOptions

TxtLoadOptions class

Represents the options for loading text file.

class TxtLoadOptions extends AbstractTextLoadOptions;

Constructors

NameDescription
constructor()Creates the options for loading text file.
constructor(AbstractTextLoadOptions)Constructs from a parent object convertible to this.
constructor(LoadFormat)Creates the options for loading text file.

Methods

MethodDescription
getSeparator()Gets and sets character separator of text file.
setSeparator(string)Gets and sets character separator of text file.
getSeparatorString()Gets and sets a string value as separator.
setSeparatorString(string)Gets and sets a string value as separator.
isMultiEncoded()True means that the file contains several encoding.
setIsMultiEncoded(boolean)True means that the file contains several encoding.
getHasFormula()Indicates whether the text is formula if it starts with “=”.
setHasFormula(boolean)Indicates whether the text is formula if it starts with “=”.
getHasTextQualifier()Whether there is text qualifier for cell value. Default is true.
setHasTextQualifier(boolean)Whether there is text qualifier for cell value. Default is true.
getTextQualifier()Specifies the text qualifier for cell values. Default qualifier is ‘"’.
setTextQualifier(string)Specifies the text qualifier for cell values. Default qualifier is ‘"’.
getTreatConsecutiveDelimitersAsOne()Whether consecutive delimiters should be treated as one.
setTreatConsecutiveDelimitersAsOne(boolean)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. 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.
setTreatQuotePrefixAsValue(boolean)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()Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.
setExtendToNextSheet(boolean)Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.
getHeaderRowsCount()The count of header rows to be repeated for extended sheets.
setHeaderRowsCount(number)The count of header rows to be repeated for extended sheets.
getHeaderColumnsCount()The count of header columns to be repeated for extended sheets.
setHeaderColumnsCount(number)The count of header columns to be repeated for extended sheets.
getMaxRowCount()The maximum count of rows to be imported for one sheet.
setMaxRowCount(number)The maximum count of rows to be imported for one sheet.
getMaxColumnCount()The maximum count of columns to be imported for one sheet.
setMaxColumnCount(number)The maximum count of columns to be imported for one sheet.
isNull()Checks whether the implementation object is null.
getLoadFormat()Gets the load format.
getPassword()Gets and set the password of the workbook.
setPassword(string)Gets and set the password of the workbook.
getParsingFormulaOnOpen()Indicates whether parsing the formula when reading the file.
setParsingFormulaOnOpen(boolean)Indicates whether parsing the formula when reading the file.
getParsingPivotCachedRecords()Indicates whether parsing pivot cached records when loading the file. The default value is false.
setParsingPivotCachedRecords(boolean)Indicates whether parsing pivot cached records when loading the file. The default value is false.
getLanguageCode()Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
setLanguageCode(CountryCode)Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
getRegion()Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
setRegion(CountryCode)Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
getDefaultStyleSettings()Gets the default style settings for initializing styles of the workbook
getInterruptMonitor()Gets and sets the interrupt monitor.
setInterruptMonitor(AbstractInterruptMonitor)Gets and sets the interrupt monitor.
getIgnoreNotPrinted()Ignore the data which are not printed if directly printing the file
setIgnoreNotPrinted(boolean)Ignore the data which are not printed if directly printing the file
getCheckDataValid()Check whether data is valid in the template file.
setCheckDataValid(boolean)Check whether data is valid in the template file.
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.
setCheckExcelRestriction(boolean)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()Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
setKeepUnparsedData(boolean)Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
getLoadFilter()The filter to denote how to load data.
setLoadFilter(LoadFilter)The filter to denote how to load data.
getLightCellsDataHandler()The data handler for processing cells data when reading template file.
setLightCellsDataHandler(LightCellsDataHandler)The data handler for processing cells data when reading template file.
getMemorySetting()Gets or sets the memory usage options.
setMemorySetting(MemorySetting)Gets or sets the memory usage options.
setWarningCallback(IWarningCallback)Gets or sets warning callback.
getWarningCallback()Gets or sets warning callback.
getAutoFitterOptions()Gets and sets the auto fitter options
setAutoFitterOptions(AutoFitterOptions)Gets and sets the auto fitter options
getAutoFilter()Indicates whether auto filtering the data when loading the files.
setAutoFilter(boolean)Indicates whether auto filtering the data when loading the files.
getFontConfigs()Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
setFontConfigs(IndividualFontConfigs)Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
getIgnoreUselessShapes()Indicates whether ignoring useless shapes.
setIgnoreUselessShapes(boolean)Indicates whether ignoring useless shapes.
getPreservePaddingSpacesInFormula()Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
setPreservePaddingSpacesInFormula(boolean)Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
setPaperSize(PaperSizeType)Sets the default print paper size from default printer’s setting.
getEncoding()Gets and sets the default encoding. Only applies for csv file.
setEncoding(EncodingType)Gets and sets the default encoding. Only applies for csv file.
getLoadStyleStrategy()Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
setLoadStyleStrategy(TxtLoadStyleStrategy)Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
getConvertNumericData()Gets or sets a value that indicates whether the string in text file is converted to numeric data.
setConvertNumericData(boolean)Gets or sets a value that indicates whether the string in text file is converted to numeric data.
getConvertDateTimeData()Gets or sets a value that indicates whether the string in text file is converted to date data.
setConvertDateTimeData(boolean)Gets or sets a value that indicates whether the string in text file is converted to date data.
getKeepPrecision()Indicates whether not parsing a string value if the length is 15.
setKeepPrecision(boolean)Indicates whether not parsing a string value if the length is 15.

constructor()

Creates the options for loading text file.

constructor();

Remarks

The default load file type is CSV .

constructor(AbstractTextLoadOptions)

Constructs from a parent object convertible to this.

constructor(obj: AbstractTextLoadOptions);

Parameters:

ParameterTypeDescription
objAbstractTextLoadOptionsThe parent object.

constructor(LoadFormat)

Creates the options for loading text file.

constructor(loadFormat: LoadFormat);

Parameters:

ParameterTypeDescription
loadFormatLoadFormatThe loading format

getSeparator()

Gets and sets character separator of text file.

getSeparator() : string;

setSeparator(string)

Gets and sets character separator of text file.

setSeparator(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getSeparatorString()

Gets and sets a string value as separator.

getSeparatorString() : string;

setSeparatorString(string)

Gets and sets a string value as separator.

setSeparatorString(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

isMultiEncoded()

True means that the file contains several encoding.

isMultiEncoded() : boolean;

setIsMultiEncoded(boolean)

True means that the file contains several encoding.

setIsMultiEncoded(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getHasFormula()

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

getHasFormula() : boolean;

setHasFormula(boolean)

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

setHasFormula(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getHasTextQualifier()

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

getHasTextQualifier() : boolean;

setHasTextQualifier(boolean)

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

setHasTextQualifier(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getTextQualifier()

Specifies the text qualifier for cell values. Default qualifier is ‘"’.

getTextQualifier() : string;

Remarks

When setting this property, HasTextQualifier will become true automatically.

setTextQualifier(string)

Specifies the text qualifier for cell values. Default qualifier is ‘"’.

setTextQualifier(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

When setting this property, HasTextQualifier will become true automatically.

getTreatConsecutiveDelimitersAsOne()

Whether consecutive delimiters should be treated as one.

getTreatConsecutiveDelimitersAsOne() : boolean;

setTreatConsecutiveDelimitersAsOne(boolean)

Whether consecutive delimiters should be treated as one.

setTreatConsecutiveDelimitersAsOne(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

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.QuotePrefix will be set as true for the cell.

getTreatQuotePrefixAsValue() : boolean;

setTreatQuotePrefixAsValue(boolean)

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.

setTreatQuotePrefixAsValue(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExtendToNextSheet()

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

getExtendToNextSheet() : boolean;

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(boolean)

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

setExtendToNextSheet(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

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()

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

getHeaderRowsCount() : number;

Remarks

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

setHeaderRowsCount(number)

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

setHeaderRowsCount(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

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

getHeaderColumnsCount()

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

getHeaderColumnsCount() : number;

Remarks

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

setHeaderColumnsCount(number)

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

setHeaderColumnsCount(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

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

getMaxRowCount()

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

getMaxRowCount() : number;

Remarks

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.

setMaxRowCount(number)

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

setMaxRowCount(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

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()

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

getMaxColumnCount() : number;

Remarks

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.

setMaxColumnCount(number)

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

setMaxColumnCount(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

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.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getLoadFormat()

Gets the load format.

getLoadFormat() : LoadFormat;

Returns

LoadFormat

getPassword()

Gets and set the password of the workbook.

getPassword() : string;

setPassword(string)

Gets and set the password of the workbook.

setPassword(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getParsingFormulaOnOpen()

Indicates whether parsing the formula when reading the file.

getParsingFormulaOnOpen() : boolean;

Remarks

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

setParsingFormulaOnOpen(boolean)

Indicates whether parsing the formula when reading the file.

setParsingFormulaOnOpen(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

getParsingPivotCachedRecords()

Indicates whether parsing pivot cached records when loading the file. The default value is false.

getParsingPivotCachedRecords() : boolean;

Remarks

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

setParsingPivotCachedRecords(boolean)

Indicates whether parsing pivot cached records when loading the file. The default value is false.

setParsingPivotCachedRecords(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

getLanguageCode()

Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

getLanguageCode() : CountryCode;

Returns

CountryCode

setLanguageCode(CountryCode)

Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

setLanguageCode(value: CountryCode) : void;

Parameters:

ParameterTypeDescription
valueCountryCodeThe value to set.

getRegion()

Gets or sets the system regional settings based on CountryCode at the time the file was loaded.

getRegion() : CountryCode;

Returns

CountryCode

Remarks

If you do not want to use the region saved in the file, please reset it after reading the file.

setRegion(CountryCode)

Gets or sets the system regional settings based on CountryCode at the time the file was loaded.

setRegion(value: CountryCode) : void;

Parameters:

ParameterTypeDescription
valueCountryCodeThe value to set.

Remarks

If you do not want to use the region saved in the file, please reset it after reading the file.

getDefaultStyleSettings()

Gets the default style settings for initializing styles of the workbook

getDefaultStyleSettings() : DefaultStyleSettings;

Returns

DefaultStyleSettings

getInterruptMonitor()

Gets and sets the interrupt monitor.

getInterruptMonitor() : AbstractInterruptMonitor;

Returns

AbstractInterruptMonitor

setInterruptMonitor(AbstractInterruptMonitor)

Gets and sets the interrupt monitor.

setInterruptMonitor(value: AbstractInterruptMonitor) : void;

Parameters:

ParameterTypeDescription
valueAbstractInterruptMonitorThe value to set.

getIgnoreNotPrinted()

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

getIgnoreNotPrinted() : boolean;

Remarks

Only for xlsx file.

setIgnoreNotPrinted(boolean)

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

setIgnoreNotPrinted(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Only for xlsx file.

getCheckDataValid()

Check whether data is valid in the template file.

getCheckDataValid() : boolean;

setCheckDataValid(boolean)

Check whether data is valid in the template file.

setCheckDataValid(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

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.

getCheckExcelRestriction() : boolean;

setCheckExcelRestriction(boolean)

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.

setCheckExcelRestriction(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getKeepUnparsedData()

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

getKeepUnparsedData() : boolean;

Remarks

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,

setKeepUnparsedData(boolean)

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

setKeepUnparsedData(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

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()

The filter to denote how to load data.

getLoadFilter() : LoadFilter;

Returns

LoadFilter

setLoadFilter(LoadFilter)

The filter to denote how to load data.

setLoadFilter(value: LoadFilter) : void;

Parameters:

ParameterTypeDescription
valueLoadFilterThe value to set.

getLightCellsDataHandler()

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

getLightCellsDataHandler() : LightCellsDataHandler;

Returns

LightCellsDataHandler

setLightCellsDataHandler(LightCellsDataHandler)

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

setLightCellsDataHandler(value: LightCellsDataHandler) : void;

Parameters:

ParameterTypeDescription
valueLightCellsDataHandlerThe value to set.

getMemorySetting()

Gets or sets the memory usage options.

getMemorySetting() : MemorySetting;

Returns

MemorySetting

setMemorySetting(MemorySetting)

Gets or sets the memory usage options.

setMemorySetting(value: MemorySetting) : void;

Parameters:

ParameterTypeDescription
valueMemorySettingThe value to set.

setWarningCallback(IWarningCallback)

Gets or sets warning callback.

setWarningCallback(value: IWarningCallback) : void;

Parameters:

ParameterTypeDescription
valueIWarningCallbackThe value to set.

getWarningCallback()

Gets or sets warning callback.

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

getAutoFitterOptions()

Gets and sets the auto fitter options

getAutoFitterOptions() : AutoFitterOptions;

Returns

AutoFitterOptions

Remarks

Only for xlsx ,spreadsheetML file now.

setAutoFitterOptions(AutoFitterOptions)

Gets and sets the auto fitter options

setAutoFitterOptions(value: AutoFitterOptions) : void;

Parameters:

ParameterTypeDescription
valueAutoFitterOptionsThe value to set.

Remarks

Only for xlsx ,spreadsheetML file now.

getAutoFilter()

Indicates whether auto filtering the data when loading the files.

getAutoFilter() : boolean;

Remarks

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

setAutoFilter(boolean)

Indicates whether auto filtering the data when loading the files.

setAutoFilter(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

getFontConfigs()

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

getFontConfigs() : IndividualFontConfigs;

Returns

IndividualFontConfigs

setFontConfigs(IndividualFontConfigs)

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

setFontConfigs(value: IndividualFontConfigs) : void;

Parameters:

ParameterTypeDescription
valueIndividualFontConfigsThe value to set.

getIgnoreUselessShapes()

Indicates whether ignoring useless shapes.

getIgnoreUselessShapes() : boolean;

Remarks

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.

setIgnoreUselessShapes(boolean)

Indicates whether ignoring useless shapes.

setIgnoreUselessShapes(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

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()

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

getPreservePaddingSpacesInFormula() : boolean;

Remarks

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.

setPreservePaddingSpacesInFormula(boolean)

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

setPreservePaddingSpacesInFormula(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.

setPaperSize(PaperSizeType)

Sets the default print paper size from default printer’s setting.

setPaperSize(type: PaperSizeType) : void;

Parameters:

ParameterTypeDescription
typePaperSizeTypeThe default paper size.

Remarks

If there is no setting about paper size,MS Excel will use default printer’s setting.

getEncoding()

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

getEncoding() : EncodingType;

Returns

EncodingType

setEncoding(EncodingType)

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

setEncoding(value: EncodingType) : void;

Parameters:

ParameterTypeDescription
valueEncodingTypeThe value to set.

getLoadStyleStrategy()

Indicates the strategy to apply style for parsed values when converting string value to number or datetime.

getLoadStyleStrategy() : TxtLoadStyleStrategy;

Returns

TxtLoadStyleStrategy

setLoadStyleStrategy(TxtLoadStyleStrategy)

Indicates the strategy to apply style for parsed values when converting string value to number or datetime.

setLoadStyleStrategy(value: TxtLoadStyleStrategy) : void;

Parameters:

ParameterTypeDescription
valueTxtLoadStyleStrategyThe value to set.

getConvertNumericData()

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

getConvertNumericData() : boolean;

setConvertNumericData(boolean)

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

setConvertNumericData(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getConvertDateTimeData()

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

getConvertDateTimeData() : boolean;

setConvertDateTimeData(boolean)

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

setConvertDateTimeData(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getKeepPrecision()

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

getKeepPrecision() : boolean;

setKeepPrecision(boolean)

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

setKeepPrecision(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.