Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelDocumentCsvExtensions

OfficeIMO.Excel.Csv

Namespace
OfficeIMO.Excel.Csv
Assembly
OfficeIMO.Excel.Csv
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

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

Inheritance

  • object
  • ExcelDocumentCsvExtensions

Methods

ImportCsv 2 overloads
public static ExcelCsvImportResult ImportCsv(ExcelDocument document, CsvDocument csv, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #

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
public static ExcelCsvImportResult ImportCsv(ExcelDocument document, Stream stream, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #

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
public static ExcelCsvImportResult ImportCsvFile(ExcelDocument document, string path, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #

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
public static ExcelCsvImportResult ImportCsvText(ExcelDocument document, string text, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #

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
SaveAsExcel 2 overloads
public static OfficeConversionReport SaveAsExcel(CsvDocument csv, string path, CsvExcelExportOptions? options = null, CancellationToken cancellationToken = default) #

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) #

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) #

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) #

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) #

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) #

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) #

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>>