ExcelDocumentCsvExtensions
OfficeIMO.Excel.Csv
Imports CSV data through the shared OfficeIMO.CSV reader pipeline.
Inheritance
- object
- ExcelDocumentCsvExtensions
Methods
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
- csv OfficeIMO.CSV.CsvDocument
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic 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
- stream System.IO.Stream
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic 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
- path string
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic 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
- text string
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic 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
- path string
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>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
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelDocumentpublic 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
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelDocumentpublic 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
- options OfficeIMO.Excel.Csv.CsvExcelExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<ExcelDocument>>