ExcelMapper

Abstract class action invoker

Invoke from an unspecified type

mapping instance class index in the collection

factory

Generic form

ref to the mapping action.

Ctor

Invoke Generic Action

Attribute that specifies the mapping of a property to a column in an Excel file.

Initializes a new instance of the class.

The name of the column. mapping direction

Initializes a new instance of the class.

The index of the column. mapping direction

Initializes a new instance of the class.

The index of the column. The name of the column. mapping direction

Initializes a new instance of the class.

mapping direction

Gets the direction of the column.

The name of the column.

Gets the name of the column.

The name of the column.

Gets the index of the column.

The index of the column.

Gets or sets the column name in Excel letter format where A refers to column 1 etc.

Gets or sets a value that indicates whether this attribute is inherited by derived classes. It is useful if you want to prevent multiple mappings created by attributes in derived classes. The default value is true.

Attribute that specifies the data format of an Excel cell. The format can either be a builtin format or a custom format string.

Gets or sets the builtin format, see https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html for possible values.

The builtin format.

Gets or sets the custom format, see https://support.office.com/en-nz/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4 for the syntax.

The custom format.

Initializes a new instance of the class.

The format, see https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html for possible values.

Initializes a new instance of the class.

The format, see https://support.office.com/en-nz/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4 for the syntax.

Attribute which specifies that the property contains a formula. This applies only to string properties and is only needed when saving Excel files.

Attribute which specifies that the formula result instead of the formula should be mapped. This applies only to string properties, as for all other types the result will be mapped.

Attribute that specifies that a property should be ignored.

Attribute that specifies that the property should be serialized as JSON.

Describes the mapping of a property to a cell in an Excel sheet.

Gets or sets the mapping directions.

Gets or sets the default cell setter.

Gets or sets the custom cell setter.

Sets the property type.

The property type.

Gets or sets the property name.

Gets or sets the property.

The property.

Gets a value indicating whether the mapped property has a nested type.

Gets a value indicating whether the property is nullable.

true if the property is nullable; otherwise, false.

Gets the type of the property.

The type of the property.

Gets or sets the cell setter.

The cell setter.

Gets or sets the property setter.

The property setter.

Gets or sets the builtin format.

The builtin format.

Gets or sets the custom format.

The custom format.

Gets or sets a value indicating whether to map the formula result.

true if the formula result will be mapped; otherwise, false.

Gets or sets a value indicating whether to save the property as a formula cell. Only needed when saving.

true if the cell will contain a formula; otherwise, false.

Gets or sets a value indicating whether to serialize as JSON.

true if the property will be serialized as JSON; otherwise, false.

Types that map a numeric column.

Types that map to a DateTime column.

Generates the cell setter.

The cell setter.

Sets the column style.

The sheet. Index of the column.

Sets the cell style.

The cell.

Computes value that can be assigned to property from cell value.

The object which contains the property. The value. The cell where the value originates from. Value that can be assigned to property.

Sets the property of the specified object to the specified value.

The object whose property to set. The value. The cell where the value originates from.

Gets the property value of the specified object.

The object from which to get the property value. The property value.

Specifies a method to use when setting the cell value from an object.

The method to use when setting the cell value from an object. The object.

Specifies a method to use when setting the cell value from an object.

The method to use when setting the cell value from an object. The object.

Specifies a method to use when setting the property value from the cell value.

The method to use when setting the property value from the cell value. The object.

Specifies a method to use when setting the property value from the cell value.

The method to use when setting the property value from the cell value. The object.

Specifies a method to use when setting the property value from the cell value.

The method to use when setting the property value from the cell value. The object.

Specifies a method to use when setting the property value from the cell value.

The method to use when setting the property value from the cell value. The object.

Specifies a method to use when setting the property value from the cell value.

The method to use when setting the property value from the cell value. The object.

Selects formula results to be mapped instead of the formula itself.

The object.

Selects the property to be saved as a formula.

The object.

Selects the property to be serialized as JSON.

The object.

Initializes a new instance of the class.

The property information. Data direction

Initializes a new instance of the class.

Selects the property to be unidirectional from Excel to Object.

The object.

Selects the property to be unidirectional from Excel to Object.

The object.

Describes the mapping of an 's property to a cell.

Gets or sets the column index.

Initializes a new instance of the class.

The column index. The column name.

Initializes a new instance of the class.

The column name. The type of the column.

Sets the property of the specified object to the specified value.

The object whose property to set. The value. The cell where the value originates from.

Gets the property value of the specified object.

The o. The property value.

Data direction

From Excel to Object

From Object to Excel

Both directions

Provides data for the event.

Gets or sets the sheet.

The sheet.

Initializes a new instance of the class.

The sheet that is being saved.

Map objects to Excel files.

Gets or sets the factory. Default is a static object that caches s statically across instances.

The factory.

Gets or sets a value indicating whether the Excel file contains a header row of column names. Default is true.

true if the Excel file contains a header row; otherwise, false.

Gets or sets the row number of the header row. Default is 0. The header row may be outside of the range of and .

The header row number.

Gets or sets the minimum row number of the rows that may contain data. Default is 0.

The minimum row number.

Gets or sets the inclusive maximum row number of the rows that may contain data. Default is .

The maximum row number.

Gets or sets a value indicating whether to track objects read from the Excel file. Default is true. If object tracking is enabled, the object keeps track of objects it yields through the Fetch() methods. You can then modify these objects and save them back to an Excel file without having to specify the list of objects to save.

true if object tracking is enabled; otherwise, false.

Gets or sets a value indicating whether to skip blank rows when reading from Excel files. Default is true.

true if blank lines are skipped; otherwise, false.

Gets or sets a value indicating whether to skip blank cells when reading from Excel files. Default is true.

true if blank lines are skipped; otherwise, false.

Gets or sets a value indicating whether to create columns in existing Excel files for properties where the corresponding header does not yet exist. If this is false and properties are mapped by name, their corresponding headers must already be present in existing files. Default is false.

true if missing headers should be created; otherwise, false.

Gets or sets a value indicating whether to ignore nested types. Default is false.

true if nested types should be ignored; otherwise, false.

Gets or sets the object to use when formatting cell values.

The object to use when formatting cell values.

Occurs before saving and allows the workbook to be manipulated.

Occurs while parsing when value is not convertible. Set Cancel to true to Cancel Exception, also, see

Initializes a new instance of the class.

Initializes a new instance of the class.

The workbook.

Initializes a new instance of the class.

The path to the Excel file.

Initializes a new instance of the class.

The stream the Excel file is read from.

Attaches the Excel file from the provided .

The workbook.

Attaches the Excel file from the provided path.

The path to the Excel file.

Attaches the Excel file read from the provided .

The stream the Excel file is read from.

Sets a factory function to create objects of type .

The type of objects to create. The factory function.

Fetches objects from the specified sheet name.

The type of objects the Excel file is mapped to. The path to the Excel file. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name.

The type of objects the Excel file is mapped to. The path to the Excel file. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name.

The path to the Excel file. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The type of objects the Excel file is mapped to. The path to the Excel file. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The type of objects the Excel file is mapped to. The path to the Excel file. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The path to the Excel file. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name.

The stream the Excel file is read from. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The stream the Excel file is read from. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name.

The type of objects the Excel file is mapped to. Name of the sheet. Allow value parsing The objects read from the Excel file. Thrown when a sheet is not found

Fetches objects from the specified sheet name.

The type of objects the Excel file is mapped to. Name of the sheet. Allow value parsing The objects read from the Excel file. Thrown when a sheet is not found

Fetches objects from the specified sheet name.

Name of the sheet. Allow value parsing The objects read from the Excel file. Thrown when a sheet is not found

Fetches objects from the specified sheet index.

The type of objects the Excel file is mapped to. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

The type of objects the Excel file is mapped to Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index.

Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name using async I/O.

The type of objects the Excel file is mapped to. The path to the Excel file. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches dynamic objects from the specified sheet name using async I/O.

The path to the Excel file. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name using async I/O.

The type of objects the Excel file is mapped to. The path to the Excel file. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index using async I/O.

The type of objects the Excel file is mapped to. The path to the Excel file. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches dynamic objects from the specified sheet index using async I/O.

The path to the Excel file. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index using async I/O.

The type of objects the Excel file is mapped to. The path to the Excel file. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name using async I/O.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches dynamic objects from the specified sheet name using async I/O.

The stream the Excel file is read from. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet name using async I/O.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Name of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index using async I/O.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches dynamic objects from the specified sheet index using async I/O.

The stream the Excel file is read from. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches objects from the specified sheet index using async I/O.

The type of objects the Excel file is mapped to. The stream the Excel file is read from. Index of the sheet. Allow value parsing The objects read from the Excel file.

Fetches the names of all sheets.

The sheet names.

Fetches the names of all sheets.

Indicates if hidden sheets should be ignored. The sheet names.

Saves the specified objects to the specified Excel file.

The type of objects to save. The path to the Excel file. The objects to save. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified Excel file.

The type of objects to save. The path to the Excel file. The objects to save. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified stream.

The type of objects to save. The stream to save the objects to. The objects to save. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified stream.

The type of objects to save. The stream to save the objects to. The objects to save. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified Excel file.

The path to the Excel file. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified Excel file.

The path to the Excel file. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified stream.

The stream to save the objects to. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified stream.

The stream to save the objects to. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified Excel file using async I/O.

The type of objects to save. The path to the Excel file. The objects to save. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified Excel file using async I/O.

The type of objects to save. The path to the Excel file. The objects to save. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified stream using async I/O.

The type of objects to save. The stream to save the objects to. The objects to save. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves the specified objects to the specified stream using async I/O.

The type of objects to save. The stream to save the objects to. The objects to save. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified Excel file using async I/O.

The path to the Excel file. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified Excel file using async I/O.

The path to the Excel file. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified stream using async I/O.

The stream to save the objects to. Name of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Saves tracked objects to the specified stream using async I/O.

The stream to save the objects to. Index of the sheet. if set to true saves in .xlsx format; otherwise, saves in .xls format. converter receiving property name and value

Action to call after an object is mapped

Action to call before an object is mapped

Adds a mapping from a column name to a property.

Name of the column. The property expression.

Adds a mapping from a column index to a property.

Index of the column. The property expression.

Adds a mapping from a column name to a property.

The type that contains the property to map to. Name of the column. Name of the property.

Adds a mapping from a column name to a property.

The type that contains the property to map to. Index of the column. Name of the property.

Ignores a property.

The property expression.

Ignores a property.

The type that contains the property to map to. Name of the property.

Sets a name normalization function. This function is used when the object tries to find a property name from a header cell value. It can be used if the input header cell values may contain a larger number of possible values that can be easily mapped backed to a single property name through a function, e.g. if the header cell may contain varying amounts of whitespace. The default is the identity function.

The name normalization function.

Sets a name normalization function. This function is used when the object tries to find a property name from a header cell value. It can be used if the input header cell values may contain a larger number of possible values that can be easily mapped backed to a single property name through a function, e.g. if the header cell may contain varying amounts of whitespace. The default is the identity function.

The type that contains the property to map to. The name normalization function.

Sets a default name normalization function. This function is used when the object tries to find a property name from a header cell value. It can be used if the input header cell values may contain a larger number of possible values that can be easily mapped backed to a single property name through a function, e.g. if the header cell may contain varying amounts of whitespace. This default normalization function works across types. If a normalization function is set for a specific type it takes precedence over this default function. The default is the identity function.

The name normalization function.

Converts Excel column letters to column indexes (e.g. "A" yields 1).

The Excel column letter. The column index.

Converts a column index to the corresponding Excel column letter or letters (e.g. 1 yields "A").

The column index. The Excel column letter or letters.

Represents an error that occurs when conversion of a cell value to the mapped property type fails.

Gets the original cell value.

The original cell value.

Gets the type of the property that the cell is mapped to.

The type of the property that the cell is mapped to.

Gets the line number of the cell where the error occurred.

The line number of the cell where the error occurred.

Gets the column number of the cell where the error occurred.

The column number of the cell where the error occurred.

Initializes a new instance of the class.

Initializes a new instance of the class.

The message the describes the error.

Initializes a new instance of the class.

The message the describes the error. The exception that is the cause of the current exception, or a null reference if no inner exception is specified.

Initializes a new instance of the class.

The value of the cell where the error occurred. The type of the property the cell is mapped to. The line number of the cell where the error occurred. The column number of the cell where the error occurred.

Initializes a new instance of the class.

The value of the cell where the error occurred. The type of the property the cell is mapped to. The line number of the cell where the error occurred. The column number of the cell where the error occurred. The exception that is the cause of the current exception, or a null reference if no inner exception is specified.

Initializes a new instance of the class with serialized data.

The object that holds the serialized data. The contextual information about the source or destination.

Sets the with information about the exception.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

convert to Nullable type

A caching factory of objects.

Creates a for the specified type.

The type to create a object for. A for the specified type.

Creates a for the specified object.

The object to create a object for. A for the specified object.

Provides data for the event. Event handler can allow parsing to continue by setting to true, cancelling the exception.

The error captured

Initializes a new instance of the class.

The error captured.

Maps a 's properties to columns in an Excel sheet.

Gets the type being mapped.

Gets or sets the columns by name.

The dictionary of columns by name.

Gets or sets the columns by index.

The dictionary of columns by index.

Gets or sets the Before Mapping action.

Gets or sets the After Mapping action.

Creates a object from the specified type.

The type. A object.

Creates a object from a list of cells.

The cells. true if the cell's contents should be used as the column name; otherwise, false. A object.

Creates a object from an object.

The object. A object.

Creates an object that includes type mapping information.

An object.

Gets or sets the constructor to initialize the mapped type. Only used if the mapped type has no default constructor.

Gets or sets the constructor parameters by name.

Gets the for the specified column name.

The column name. A object or null if no exists for the specified column name.

Gets the for the specified column index.

The column index. A object or null if no exists for the specified column index.

A caching factory of objects.

Creates a for the specified type.

The type to create a object for. A for the specified type.

Creates a for the specified object.

The object to create a object for. A for the specified object.