Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelSheetCsvExtensions

OfficeIMO.Excel.Csv

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

Imports and exports worksheet data through the shared OfficeIMO.CSV pipeline.

Inheritance

  • object
  • ExcelSheetCsvExtensions

Methods

ImportCsv 2 overloads
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 required
csv OfficeIMO.CSV.CsvDocument required
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public 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 required
stream System.IO.Stream required
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public 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 required
path string required
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public 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 required
text string required
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
SaveAsCsv 2 overloads
public 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 required
path string required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public 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 required
stream System.IO.Stream required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsCsvAsync 2 overloads
public 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 required
path string required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
stream System.IO.Stream required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToCsv 2 overloads
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 required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

CsvDocument
public 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 required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

CsvDocument
public 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 required
options OfficeIMO.Excel.Csv.ExcelCsvExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<CsvDocument>>