Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

ExcelDocumentCsvExtensions

Namespace OfficeIMO.Excel.Csv
Assembly OfficeIMO.Excel.Csv
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) #
Returns: ExcelCsvImportResult

Imports a loaded CSV document into a new worksheet.

Parameters

arg1 OfficeIMO.Excel.ExcelDocument requiredposition: 0
arg2 OfficeIMO.CSV.CsvDocument requiredposition: 1
arg3 OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static ExcelCsvImportResult ImportCsv(ExcelDocument document, Stream stream, ExcelCsvImportOptions options = null, CancellationToken cancellationToken = default) #
Returns: ExcelCsvImportResult

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

Parameters

arg1 OfficeIMO.Excel.ExcelDocument requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static ExcelCsvImportResult ImportCsvFile(ExcelDocument document, String path, ExcelCsvImportOptions options = null, CancellationToken cancellationToken = default) #
Returns: ExcelCsvImportResult

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

Parameters

document OfficeIMO.Excel.ExcelDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static ExcelCsvImportResult ImportCsvText(ExcelDocument document, String text, ExcelCsvImportOptions options = null, CancellationToken cancellationToken = default) #
Returns: ExcelCsvImportResult

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

Parameters

document OfficeIMO.Excel.ExcelDocument requiredposition: 0
text System.String requiredposition: 1
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
SaveAsExcel 2 overloads
public static Void SaveAsExcel(CsvDocument csv, String path, ExcelCsvImportOptions importOptions = null, ExcelSaveOptions saveOptions = null, CancellationToken cancellationToken = default) #
Returns: Void

Converts a loaded CSV document and saves it as an Excel workbook.

Parameters

arg1 OfficeIMO.CSV.CsvDocument requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 2
arg4 OfficeIMO.Excel.ExcelSaveOptions = null optionalposition: 3
arg5 System.Threading.CancellationToken = default optionalposition: 4
public static Void SaveAsExcel(CsvDocument csv, Stream stream, ExcelCsvImportOptions importOptions = null, ExcelSaveOptions saveOptions = null, CancellationToken cancellationToken = default) #
Returns: Void

Converts a loaded CSV document and saves it to an Excel workbook stream.

Parameters

arg1 OfficeIMO.CSV.CsvDocument requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 2
arg4 OfficeIMO.Excel.ExcelSaveOptions = null optionalposition: 3
arg5 System.Threading.CancellationToken = default optionalposition: 4
public static ExcelDocument ToExcelDocument(CsvDocument csv, ExcelCsvImportOptions options = null, ExcelCreateOptions createOptions = null, CancellationToken cancellationToken = default) #
Returns: ExcelDocument

Creates a detached Excel workbook from a loaded CSV document.

Parameters

csv OfficeIMO.CSV.CsvDocument requiredposition: 0
options OfficeIMO.Excel.Csv.ExcelCsvImportOptions = null optionalposition: 1
createOptions OfficeIMO.Excel.ExcelCreateOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3