# ExcelDocumentCsvExtensions

Imports CSV data through the shared OfficeIMO.CSV reader pipeline.

Class 

`OfficeIMO.Excel.Csv`

**Namespace**

`OfficeIMO.Excel.Csv`

**Assembly**

`OfficeIMO.Excel.Csv`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ExcelDocumentCsvExtensions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L17)

**Modifiers**

static

Imports CSV data through the shared OfficeIMO.CSV reader pipeline.

## Inheritance

- object
- ExcelDocumentCsvExtensions

Filter members 

Show inherited

## Methods

ImportCsv 2 overloads

`public static ExcelCsvImportResult ImportCsv(ExcelDocument document, CsvDocument csv, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-importcsv-officeimo-excel-exceldocument-officeimo-csv-csvdocument-officeimo-excel-csv-excelcsvimportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L17)

Imports a loaded CSV document into a new worksheet.

Parameters

**document OfficeIMO.Excel.ExcelDocument required**

**csv OfficeIMO.CSV.CsvDocument required**

**options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`ExcelCsvImportResult`

`public static ExcelCsvImportResult ImportCsv(ExcelDocument document, Stream stream, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-importcsv-officeimo-excel-exceldocument-io-stream-officeimo-excel-csv-excelcsvimportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L45)

Reads a caller-owned CSV stream and imports it into a new worksheet.

Parameters

**document OfficeIMO.Excel.ExcelDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`ExcelCsvImportResult`

`public static ExcelCsvImportResult ImportCsvFile(ExcelDocument document, string path, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-importcsvfile-officeimo-excel-exceldocument-string-officeimo-excel-csv-excelcsvimportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L31)

Opens a CSV file and imports it into a new worksheet.

Parameters

**document OfficeIMO.Excel.ExcelDocument required**

**path string required**

**options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`ExcelCsvImportResult`

`public static ExcelCsvImportResult ImportCsvText(ExcelDocument document, string text, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-importcsvtext-officeimo-excel-exceldocument-string-officeimo-excel-csv-excelcsvimportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L61)

Parses CSV text and imports it into a new worksheet. Because the input is already decoded, CsvReaderOptions.Encoding applies only to file and stream imports.

Parameters

**document OfficeIMO.Excel.ExcelDocument required**

**text string required**

**options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`ExcelCsvImportResult`

SaveAsExcel 2 overloads

`public static OfficeConversionReport SaveAsExcel(CsvDocument csv, string path, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasexcel-officeimo-csv-csvdocument-string-officeimo-excel-csv-csvexcelexportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:107](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L107)

Writes CSV data as a workbook and returns the conversion report.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**path string required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsExcel(CsvDocument csv, Stream stream, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasexcel-officeimo-csv-csvdocument-io-stream-officeimo-excel-csv-csvexcelexportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:115](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L115)

Writes CSV data as a workbook and returns the conversion report.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

SaveAsExcelAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsExcelAsync(CsvDocument csv, string path, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasexcelasync-officeimo-csv-csvdocument-string-officeimo-excel-csv-csvexcelexportoptions-threading-cancellationtoken)

Asynchronously writes CSV data as a workbook and returns the conversion report.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**path string required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsExcelAsync(CsvDocument csv, Stream stream, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasexcelasync-officeimo-csv-csvdocument-io-stream-officeimo-excel-csv-csvexcelexportoptions-threading-cancellationtoken)

Asynchronously writes CSV data as a workbook and returns the conversion report.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

ToExcel 2 overloads

`public static ExcelDocument ToExcel(CsvDocument csv, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toexcel-officeimo-csv-csvdocument-officeimo-excel-csv-csvexcelexportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L72)

Converts CSV into a detached editable workbook owned by the caller.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`ExcelDocument`

`public static ExcelDocument ToExcel(CsvDocument csv, CsvExcelExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-toexcel-officeimo-csv-csvdocument-officeimo-excel-csv-csvexcelexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L77)

Converts CSV and returns the completed data-projection report.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`ExcelDocument`

`public static Task<OfficeConversionResult<ExcelDocument>> ToExcelAsync(CsvDocument csv, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toexcelasync-officeimo-csv-csvdocument-officeimo-excel-csv-csvexcelexportoptions-threading-cancellationtoken)

[ExcelDocumentCsvExtensions.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Csv/ExcelDocumentCsvExtensions.cs#L102)

Converts CSV asynchronously and returns the workbook with its report.

Parameters

**csv OfficeIMO.CSV.CsvDocument required**

**options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionResult<ExcelDocument>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:2FBE2732EE8C928AFF7D39323A0A37A0ED99B50EAF8F3844A4EE190105BF5EB7 -->
