TxtLoadOptions Class

TxtLoadOptions class

Represents the options for loading text file.

type TxtLoadOptions struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description
NewTxtLoadOptions	Creates the options for loading text file.
NewTxtLoadOptions_LoadFormat	Creates the options for loading text file.
NewTxtLoadOptions_AbstractTextLoadOptions	Constructs from a parent object.

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
GetSeparator	Gets and sets character separator of text file.
SetSeparator	Gets and sets character separator of text file.
GetSeparatorString	Gets and sets a string value as separator.
SetSeparatorString	Gets and sets a string value as separator.
IsMultiEncoded	True means that the file contains several encoding.
SetIsMultiEncoded	True means that the file contains several encoding.
GetHasFormula	Indicates whether the text is formula if it starts with “=”.
SetHasFormula	Indicates whether the text is formula if it starts with “=”.
GetHasTextQualifier	Whether there is text qualifier for cell value. Default is true.
SetHasTextQualifier	Whether there is text qualifier for cell value. Default is true.
GetTextQualifier	Specifies the text qualifier for cell values. Default qualifier is ‘"’.
SetTextQualifier	Specifies the text qualifier for cell values. Default qualifier is ‘"’.
GetTreatConsecutiveDelimitersAsOne	Whether consecutive delimiters should be treated as one.
SetTreatConsecutiveDelimitersAsOne	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 valueand Style.QuotePrefix will be set as true for the cell.
SetTreatQuotePrefixAsValue	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 valueand 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	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	The count of header rows to be repeated for extended sheets.
GetHeaderColumnsCount	The count of header columns to be repeated for extended sheets.
SetHeaderColumnsCount	The count of header columns to be repeated for extended sheets.
GetMaxRowCount	The maximum count of rows to be imported for one sheet.
SetMaxRowCount	The maximum count of rows to be imported for one sheet.
GetMaxColumnCount	The maximum count of columns to be imported for one sheet.
SetMaxColumnCount	The maximum count of columns to be imported for one sheet.
GetEncoding	Gets and sets the default encoding. Only applies for csv file.
SetEncoding	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	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	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	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	Indicates whether not parsing a string value if the length is 15.
GetLoadFormat	Gets the load format.
GetPassword	Gets and set the password of the workbook.
SetPassword	Gets and set the password of the workbook.
GetParsingFormulaOnOpen	Indicates whether parsing the formula when reading the file.
SetParsingFormulaOnOpen	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	Indicates whether parsing pivot cached records when loading the file.The default value is false.
SetPaperSize	Sets the default print paper size from default printer’s setting.
GetLanguageCode	Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
SetLanguageCode	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	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	Gets and sets the interrupt monitor.
GetIgnoreNotPrinted	Ignore the data which are not printed if directly printing the file
SetIgnoreNotPrinted	Ignore the data which are not printed if directly printing the file
GetCheckDataValid	Check whether data is valid in the template file.
SetCheckDataValid	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 lateryou 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	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 lateryou 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	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	The filter to denote how to load data.
GetMemorySetting	Gets or sets the memory usage options.
SetMemorySetting	Gets or sets the memory usage options.
GetAutoFitterOptions	Gets and sets the auto fitter options
SetAutoFitterOptions	Gets and sets the auto fitter options
GetAutoFilter	Indicates whether auto filtering the data when loading the files.
SetAutoFilter	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	Gets and sets individual font configs.Only works for the Workbook which uses this LoadOptions to load.
GetIgnoreUselessShapes	Indicates whether ignoring useless shapes.
SetIgnoreUselessShapes	Indicates whether ignoring useless shapes.
GetPreservePaddingSpacesInFormula	Indicates whether preserve those spaces and line breaks that are padded between formula tokenswhile getting and setting formulas.Default value is false.
SetPreservePaddingSpacesInFormula	Indicates whether preserve those spaces and line breaks that are padded between formula tokenswhile getting and setting formulas.Default value is false.