TxtLoadOptions

TxtLoadOptions class

Represents the options for loading text file.

public class TxtLoadOptions : AbstractTextLoadOptions

Constructors

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

Properties

Name Description
AutoFilter { get; set; } Indicates whether auto filtering the data when loading the files.
AutoFitterOptions { get; set; } Gets and sets the auto fitter options
CheckDataValid { get; set; } Check whether data is valid in the template file.
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.
ConvertDateTimeData { get; set; } Gets or sets a value that indicates whether the string in text file is converted to date data.
ConvertNumericData { get; set; } Gets or sets a value that indicates whether the string in text file is converted to numeric data.
CultureInfo { get; set; } Gets or sets the system culture info at the time the file was loaded.
DefaultStyleSettings { get; } Gets the default style settings for initializing styles of the workbook
Encoding { get; set; } Gets and sets the default encoding. Only applies for csv file.
ExtendToNextSheet { get; set; } Whether extends data to next sheet when the rows or columns of data exceed limit. If this property is true, extra data will be extended to 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 exceeds limit will be ignored. Default is false;
FontConfigs { get; set; } Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
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.
IgnoreNotPrinted { get; set; } Ignore the data which are not printed if directly printing the file
InterruptMonitor { get; set; } Gets and sets the interrupt monitor.
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.
KeepUnparsedData { get; set; } Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
LanguageCode { get; set; } Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
LightCellsDataHandler { get; set; } The data handler for processing cells data when reading template file.
LoadFilter { get; set; } The filter to denote how to load data.
LoadFormat { get; } Gets the load format.
LoadStyleStrategy { get; set; } Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
MemorySetting { get; set; } Gets or sets the memory usage options.
ParsingFormulaOnOpen { get; set; } Indicates whether parsing the formula when reading the file.
ParsingPivotCachedRecords { get; set; } Indicates whether parsing pivot cached records when loading the file. The default value is false.
Password { get; set; } Gets and set the password of the workbook.
PreferredParsers { get; set; } Gets and sets preferred value parsers for loading text file.
Region { get; set; } Gets or sets the system regional settings based on CountryCode at the time the file was loaded.
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; } Sets the default standard font name
StandardFontSize { get; set; } Sets the default standard font size.
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.

Methods

Name Description
SetPaperSize(PaperSizeType) Sets the default print paper size from default printer’s setting.

See Also