Namespace actionETL.EPPlus

Provides XLSX spreadsheet file dataflow import and export. Also see XLSX (Excel) Spreadsheets.

It uses the EPPlus library internally.

Classes

XlsxSource<TOutput>

A dataflow worker with one Output and one ErrorOutput port that reads data records from a rectangular area on one sheet in an XLSX spreadsheet file, and sends them to a downstream worker. No driver installation is required (it uses the EPPlus library internally).

Also see XLSX Spreadsheet.

XlsxTarget<TInput>

A dataflow worker with one Input port, which consumes incoming rows and writes them to a rectangular area on one sheet in an XLSX spreadsheet file. No driver installation is required (it uses the EPPlus library internally).

Note: Use the factory methods in XlsxTargetFactory to create instances of this class.

Also see XLSX Spreadsheet.

XlsxTargetFactory

Factory methods that create an XlsxTarget<TInput> dataflow worker with one Input port, which consumes incoming rows and writes them to a rectangular area on one sheet in an XLSX spreadsheet file. No driver installation is required (it uses the EPPlus library internally).

The Input port is linked to (if available) the upstream output or error output port specified by the factory.

Get the factory from Link when the upstream port is known ahead of time (which is usually the case). Otherwise get it from GetDownstreamFactory<TInput>(), and link the transform or target explicitly using LinkTo(InputPort<TOutput>) or LinkFrom(OutputPortBase<TInput>).

Also see XLSX Spreadsheet.

Interfaces

IXlsxSourceCommand

Defines mappings between the XLSX spreadsheet file source columns and downstream row columns. Note that multiple commands can be chained together, e.g.: xsc => xsc.Name("A", "RowNumber").Name("B", "Category"). Supports reading from a rectangular area on one sheet in the XLSX file. The default address is the top left cell (i.e. "A1") on the first sheet.

If HeaderRow is false or the column header is missing, use ordinal position or source column addresses ("B", "AD" etc.) to specify which columns to import.

Mapping commands that can map multiple columns ignore already mapped columns. Use Name(String, String) to map the same source column multiple times.

Note that some of the mapping commands explicitly control in which order to read and populate columns, while others use OrderAttribute added to the row members. You can mix the two approaches.

By default, any column errors are rejected to the ErrorOutputPort<TError>.

Also see XLSX Spreadsheet.

IXlsxTargetCommand

Defines mappings between incoming dataflow row columns and columns in the output XLSX spreadsheet file. Supports writing to a rectangular area on one sheet in the XLSX file. The default address is the top left cell (i.e. "A1") on the first sheet. If there is no existing sheet, a new sheet called "Sheet1" will be created.

Note that multiple commands can be chained together, e.g.: xtc => xtc.Name("RowNumber", "A").Name("Category", "B"). Each exporting command will write to the next column from where the previous command left off. Use Address(String) to set where to start the export, and Column(String) to skip columns.

Mapping commands that can map multiple columns ignore already mapped columns. Use Name(String, String) to map the same column multiple times.

Note that some of the mapping commands explicitly control in which order to write columns, while others use OrderAttribute added to the row members. You can mix the two approaches.

Also see XLSX Spreadsheet.

Enums

XlsxTargetWriteOption

An enum indicating whether XlsxTarget<TInput> should use or overwrite any existing file.