Constructor Summary |
---|
TxtLoadOptions()
Creates the options for loading text file. |
TxtLoadOptions(loadFormat)
Creates the options for loading text file. |
Property Getters/Setters Summary | ||
---|---|---|
function | getAutoFitterOptions() | |
function | setAutoFitterOptions(value) | |
Gets and sets the auto fitter options | ||
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 | getEncoding() | |
function | setEncoding(value) | |
Gets and sets the default encoding.Only applies for csv file. | ||
function | getFontConfigs() | |
function | setFontConfigs(value) | |
Gets and sets individual font configs.
Only works for the |
||
function | hasFormula() | |
function | setHasFormula(value) | |
Indicates whether the text is formula if it starts with "=". | ||
function | getIgnoreNotPrinted() | |
function | setIgnoreNotPrinted(value) | |
Ignore the data which are not printed if directly printing the file | ||
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 | getKeepExactFormat() | |
function | setKeepExactFormat(value) | |
Indicates whether the exact formatting should be kept for the cell when converting string value to number or datetime. When ms excel loading datetime or numeric values from csv file, the formatting of those values may be changed, such as leading/tailing zeros of number, year/month/day order of datetime, ...etc. To simulate ms excel's behavior, please set this property to false. Default value of this property is true, so the cell value will be formatted as the same string value in csv template file. | ||
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 | getLoadDataAndFormatting() | |
function | setLoadDataAndFormatting(value) | |
If true, only loads data , formulas and formatting from the file, other contents and settings are all discarded. For example : shapes ,validation,conditional formatting,pivotables are not loaded. | ||
function | getLoadDataFilterOptions() | |
function | setLoadDataFilterOptions(value) | |
The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant. | ||
function | getLoadDataOnly() | |
function | setLoadDataOnly(value) | |
If true, only loads data and formulas from the file, other contents and settings are all discarded. | ||
function | getLoadDataOptions() | |
function | setLoadDataOptions(value) | |
Only effects when OnlyLoadData is true. | ||
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 | getMemorySetting() | |
function | setMemorySetting(value) | |
Gets or sets the memory usage options. The value of the property is MemorySetting integer constant. | ||
function | getOnlyLoadDocumentProperties() | |
function | setOnlyLoadDocumentProperties(value) | |
If true, only loads document properties | ||
function | getParsingFormulaOnOpen() | |
function | setParsingFormulaOnOpen(value) | |
Indicates whether parsing the formula when reading the file. | ||
function | getParsingPivotCachedRecords() | |
function | setParsingPivotCachedRecords(value) | |
Inidicates whether parsing pivot cached records when loadiing 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 | 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 the 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 | getTreatConsecutiveDelimitersAsOne() | |
function | setTreatConsecutiveDelimitersAsOne(value) | |
Whether consecutive delimiters should be treated as one. |
Method Summary | ||
---|---|---|
function | setPaperSize(type) | → inherited from LoadOptions |
Sets the default print paper size from default printer's setting. |
Constructor Detail |
---|
function TxtLoadOptions()
function TxtLoadOptions(loadFormat)
loadFormat: Number
- A Property Getters/Setters Detail |
---|
getConvertNumericData/setConvertNumericData : boolean | |
function getConvertNumericData() / function setConvertNumericData(value) |
getSeparator/setSeparator : char | |
function getSeparator() / function setSeparator(value) |
getSeparatorString/setSeparatorString : String | |
function getSeparatorString() / function setSeparatorString(value) |
getEncoding/setEncoding : Encoding | |
function getEncoding() / function setEncoding(value) |
isMultiEncoded/setMultiEncoded : boolean | |
function isMultiEncoded() / function setMultiEncoded(value) |
getPreferredParsers/setPreferredParsers : ICustomParser[] | |
function getPreferredParsers() / function setPreferredParsers(value) |
getConvertDateTimeData/setConvertDateTimeData : boolean | |
function getConvertDateTimeData() / function setConvertDateTimeData(value) |
getLoadStyleStrategy/setLoadStyleStrategy : Number | |
function getLoadStyleStrategy() / function setLoadStyleStrategy(value) |
hasFormula/setHasFormula : boolean | |
function hasFormula() / function setHasFormula(value) |
getTreatConsecutiveDelimitersAsOne/setTreatConsecutiveDelimitersAsOne : boolean | |
function getTreatConsecutiveDelimitersAsOne() / function setTreatConsecutiveDelimitersAsOne(value) |
getKeepExactFormat/setKeepExactFormat : boolean | |
function getKeepExactFormat() / function setKeepExactFormat(value) |
getLoadFormat : Number | |
function getLoadFormat() |
getPassword/setPassword : String | |
function getPassword() / function setPassword(value) |
getParsingFormulaOnOpen/setParsingFormulaOnOpen : boolean | |
function getParsingFormulaOnOpen() / function setParsingFormulaOnOpen(value) |
getParsingPivotCachedRecords/setParsingPivotCachedRecords : boolean | |
function getParsingPivotCachedRecords() / function setParsingPivotCachedRecords(value) |
getLoadDataAndFormatting/setLoadDataAndFormatting : boolean | |
function getLoadDataAndFormatting() / function setLoadDataAndFormatting(value) |
getLoadDataOnly/setLoadDataOnly : boolean | |
function getLoadDataOnly() / function setLoadDataOnly(value) |
getOnlyLoadDocumentProperties/setOnlyLoadDocumentProperties : boolean | |
function getOnlyLoadDocumentProperties() / function setOnlyLoadDocumentProperties(value) |
getLoadDataOptions/setLoadDataOptions : LoadDataOption | |
function getLoadDataOptions() / function setLoadDataOptions(value) |
getLanguageCode/setLanguageCode : Number | |
function getLanguageCode() / function setLanguageCode(value) |
getRegion/setRegion : Number | |
function getRegion() / function setRegion(value) |
getLocale/setLocale : Locale | |
function getLocale() / function setLocale(value) |
getStandardFont/setStandardFont : String | |
function getStandardFont() / function setStandardFont(value) |
getStandardFontSize/setStandardFontSize : Number | |
function getStandardFontSize() / function setStandardFontSize(value) |
getInterruptMonitor/setInterruptMonitor : InterruptMonitor | |
function getInterruptMonitor() / function setInterruptMonitor(value) |
getIgnoreNotPrinted/setIgnoreNotPrinted : boolean | |
function getIgnoreNotPrinted() / function setIgnoreNotPrinted(value) |
getCheckExcelRestriction/setCheckExcelRestriction : boolean | |
function getCheckExcelRestriction() / function setCheckExcelRestriction(value) |
getLoadFilter/setLoadFilter : LoadFilter | |
function getLoadFilter() / function setLoadFilter(value) |
getLoadDataFilterOptions/setLoadDataFilterOptions : Number | |
function getLoadDataFilterOptions() / function setLoadDataFilterOptions(value) |
getLightCellsDataHandler/setLightCellsDataHandler : LightCellsDataHandler | |
function getLightCellsDataHandler() / function setLightCellsDataHandler(value) |
getMemorySetting/setMemorySetting : Number | |
function getMemorySetting() / function setMemorySetting(value) |
getAutoFitterOptions/setAutoFitterOptions : AutoFitterOptions | |
function getAutoFitterOptions() / function setAutoFitterOptions(value) |
getFontConfigs/setFontConfigs : IndividualFontConfigs | |
function getFontConfigs() / function setFontConfigs(value) |
Method Detail |
---|
setPaperSize | |
function setPaperSize(type) |
type: Number
- A