 | Import |
The import options define global rules to import worksheets. The options are mainly to override particular cell types (e.g. interpretation of dates as numbers)
Inheritance HierarchySystemObject
NanoXLSXImportOptions
NanoXLSXImportOptions
Namespace: NanoXLSX
Assembly: NanoXLSX (in NanoXLSX.dll) Version: 2.6.7+3223c8b99fcd3402b4ae016daa480abac16f8a9f
SyntaxC#
public class ImportOptions
The ImportOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | ImportOptions | |
 | ImportOptions | Initializes a new instance of the ImportOptions class |
Properties| Name | Description | |
|---|---|---|
 | DateTimeFormat | Format if DateTime values are cast to strings or DateTime objects are parsed from strings. If null or empty, parsing will be tried with 'best effort', according to . See also TemporalCultureInfo |
| EnforceDateTimesAsNumbers | If true, date or time values (default format number 14 or 21) will be interpreted as numeric values globally. This option overrules possible column options, defined by AddEnforcedColumn(Int32, ImportOptionsColumnType). |
| EnforcedColumnTypes | Type enforcing rules during import for particular columns |
| EnforceEmptyValuesAsString | If true, empty cells will be interpreted as type of string with an empty value. If false, the type will be Empty and the value null |
| EnforcePhoneticCharacterImport | If true, phonetic characters (like ruby characters / Furigana / Zhuyin fuhao) in strings are added in brackets after the transcribed symbols. By default, phonetic characters are removed from strings. |
| EnforceValidColumnDimensions | If true, invalid column dimensions (larger than MAX_COLUMN_WIDTH or smaller than MIN_COLUMN_WIDTH) will throw an exception on when reading a workbook. If false, such invalid values will be ignored and set to MAX_COLUMN_WIDTH or MIN_COLUMN_WIDTH. Default is true |
| EnforceValidRowDimensions | If true, invalid row dimensions (larger than MAX_ROW_HEIGHT or smaller than MIN_ROW_HEIGHT) will throw an exception on when reading a workbook. If false, such invalid values will be ignored and set to MAX_ROW_HEIGHT or MIN_ROW_HEIGHT. Default is true |
| EnforcingStartRowNumber | The row number (zero-based) where enforcing rules are started to be applied. This is, for instance, to prevent enforcing types in a header row. Any enforcing rule is skipped until this row number is reached |
| GlobalEnforcingType | Global strategy to handle cell values. The default will not enforce any general casting, beside defined values of , and |
| TemporalCultureInfo | Culture info instance, used to parse DateTime or TimeSpan objects from strings. If null, parsing will be tried with 'best effort', according to . See also DateTimeFormat and TimeSpanFormat |
| TimeSpanFormat | Format if TimeSpan values are cast to strings |
Methods| Name | Description | |
|---|---|---|
| AddEnforcedColumn(Int32, ImportOptionsColumnType) | Adds a type enforcing rule to the passed column number (zero-based) |
| AddEnforcedColumn(String, ImportOptionsColumnType) | Adds a type enforcing rule to the passed column address |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
 | DEFAULT_CULTURE_INFO | Default culture info instance (invariant culture) used for date and time parsing, if no custom culture info is defined |
| DEFAULT_DATETIME_FORMAT | Default format if DateTime values are cast to strings |
| DEFAULT_TIMESPAN_FORMAT | Default format if TimeSpan values are cast to strings |
See Also