ExcelSheetCsvExtensions
OfficeIMO.Excel.Csv
Imports and exports worksheet data through the shared OfficeIMO.CSV pipeline.
Inheritance
- object
- ExcelSheetCsvExtensions
Methods
public static ExcelCsvImportResult ImportCsv(ExcelSheet sheet, CsvDocument csv, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #Imports a loaded CSV document into an existing worksheet.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- csv OfficeIMO.CSV.CsvDocument
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic static ExcelCsvImportResult ImportCsv(ExcelSheet sheet, Stream stream, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #Reads a caller-owned CSV stream and imports it into an existing worksheet.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- stream System.IO.Stream
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic static ExcelCsvImportResult ImportCsvFile(ExcelSheet sheet, string path, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #Opens a CSV file and imports it into an existing worksheet.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- path string
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic static ExcelCsvImportResult ImportCsvText(ExcelSheet sheet, string text, ExcelCsvImportOptions? options = null, CancellationToken cancellationToken = default) #Parses CSV text and imports it into an existing worksheet. Because the input is already decoded, CsvReaderOptions.Encoding applies only to file and stream imports.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- text string
- options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelCsvImportResultpublic static OfficeConversionReport SaveAsCsv(ExcelSheet sheet, string path, ExcelCsvExportOptions? options = null, CancellationToken cancellationToken = default) #Streams worksheet values as CSV without materializing the target document.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- path string
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsCsv(ExcelSheet sheet, Stream stream, ExcelCsvExportOptions? options = null, CancellationToken cancellationToken = default) #Streams worksheet values as CSV without materializing the target document.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- stream System.IO.Stream
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static Task<OfficeConversionReport> SaveAsCsvAsync(ExcelSheet sheet, string path, ExcelCsvExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously streams worksheet values as CSV without materializing the target document.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- path string
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static Task<OfficeConversionReport> SaveAsCsvAsync(ExcelSheet sheet, Stream stream, ExcelCsvExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously streams worksheet values as CSV without materializing the target document.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- stream System.IO.Stream
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static CsvDocument ToCsv(ExcelSheet sheet, ExcelCsvExportOptions? options = null, CancellationToken cancellationToken = default) #Projects the selected worksheet values into a materialized CSV model.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
CsvDocumentpublic static CsvDocument ToCsv(ExcelSheet sheet, ExcelCsvExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Projects values and reports the limits of CSV fidelity for workbook features.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
CsvDocumentpublic static Task<OfficeConversionResult<CsvDocument>> ToCsvAsync(ExcelSheet sheet, ExcelCsvExportOptions? options = null, CancellationToken cancellationToken = default) #Projects worksheet values asynchronously and returns the model and fidelity report.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<CsvDocument>>