Class TxtLoadOptions

TxtLoadOptions class

Represents the options for loading text file.

public class TxtLoadOptions : AbstractTextLoadOptions

Constructors

NameDescription
TxtLoadOptions()Creates the options for loading text file.
TxtLoadOptions(LoadFormat)Creates the options for loading text file.

Properties

NameDescription
AutoFilter { get; set; }Indicates whether auto filtering the data when loading the files.(Inherited from LoadOptions.)
AutoFitterOptions { get; set; }Gets and sets the auto fitter options(Inherited from LoadOptions.)
CheckDataValid { get; set; }Check whether data is valid in the template file.(Inherited from LoadOptions.)
CheckExcelRestriction { get; set; }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.(Inherited from LoadOptions.)
ConvertDateTimeData { get; set; }Gets or sets a value that indicates whether the string in text file is converted to date data.(Inherited from AbstractTextLoadOptions.)
ConvertNumericData { get; set; }Gets or sets a value that indicates whether the string in text file is converted to numeric data.(Inherited from AbstractTextLoadOptions.)
CultureInfo { get; set; }Gets or sets the system culture info at the time the file was loaded.(Inherited from LoadOptions.)
DefaultStyleSettings { get; }Gets the default style settings for initializing styles of the workbook(Inherited from LoadOptions.)
Encoding { get; set; }Gets and sets the default encoding. Only applies for csv file.(Inherited from AbstractTextLoadOptions.)
ExtendToNextSheet { get; set; }Whether extends data to next sheet when the rows or columns of data exceed limit. Default is false.
FontConfigs { get; set; }Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.(Inherited from LoadOptions.)
HasFormula { get; set; }Indicates whether the text is formula if it starts with “=”.
HasTextQualifier { get; set; }Whether there is text qualifier for cell value. Default is true.
HeaderColumnsCount { get; set; }The count of header columns to be repeated for extended sheets.
HeaderRowsCount { get; set; }The count of header rows to be repeated for extended sheets.
IgnoreNotPrinted { get; set; }Ignore the data which are not printed if directly printing the file(Inherited from LoadOptions.)
IgnoreUselessShapes { get; set; }Indicates whether ignoring useless shapes.(Inherited from LoadOptions.)
InterruptMonitor { get; set; }Gets and sets the interrupt monitor.(Inherited from LoadOptions.)
IsMultiEncoded { get; set; }True means that the file contains several encoding.
KeepPrecision { get; set; }Indicates whether not parsing a string value if the length is 15.(Inherited from AbstractTextLoadOptions.)
KeepUnparsedData { get; set; }Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.(Inherited from LoadOptions.)
LanguageCode { get; set; }Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.(Inherited from LoadOptions.)
LightCellsDataHandler { get; set; }The data handler for processing cells data when reading template file.(Inherited from LoadOptions.)
LoadFilter { get; set; }The filter to denote how to load data.(Inherited from LoadOptions.)
LoadFormat { get; }Gets the load format.(Inherited from LoadOptions.)
LoadStyleStrategy { get; set; }Indicates the strategy to apply style for parsed values when converting string value to number or datetime.(Inherited from AbstractTextLoadOptions.)
MaxColumnCount { get; set; }The maximum count of columns to be imported for one sheet.
MaxRowCount { get; set; }The maximum count of rows to be imported for one sheet.
MemorySetting { get; set; }Gets or sets the memory usage options.(Inherited from LoadOptions.)
ParsingFormulaOnOpen { get; set; }Indicates whether parsing the formula when reading the file.(Inherited from LoadOptions.)
ParsingPivotCachedRecords { get; set; }Indicates whether parsing pivot cached records when loading the file. The default value is false.(Inherited from LoadOptions.)
Password { get; set; }Gets and set the password of the workbook.(Inherited from LoadOptions.)
PreferredParsers { get; set; }Gets and sets preferred value parsers for loading text file.
PreservePaddingSpacesInFormula { get; set; }Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.(Inherited from LoadOptions.)
Region { get; set; }Gets or sets the system regional settings based on CountryCode at the time the file was loaded.(Inherited from LoadOptions.)
Separator { get; set; }Gets and sets character separator of text file.
SeparatorString { get; set; }Gets and sets a string value as separator.
StandardFont { get; set; }(Obsolete.) Sets the default standard font name(Inherited from LoadOptions.)
StandardFontSize { get; set; }(Obsolete.) Sets the default standard font size.(Inherited from LoadOptions.)
TextQualifier { get; set; }Specifies the text qualifier for cell values. Default qualifier is ‘"’.
TreatConsecutiveDelimitersAsOne { get; set; }Whether consecutive delimiters should be treated as one.
TreatQuotePrefixAsValue { get; set; }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 QuotePrefix will be set as true for the cell.
WarningCallback { get; set; }Gets or sets warning callback.(Inherited from LoadOptions.)

Methods

NameDescription
SetPaperSize(PaperSizeType)Sets the default print paper size from default printer’s setting.(Inherited from LoadOptions.)

See Also