Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelOpenDocumentConversionExtensions

OfficeIMO.Excel.OpenDocument

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

Explicit conversions between OfficeIMO Excel and native OpenDocument spreadsheet models.

Inheritance

  • object
  • ExcelOpenDocumentConversionExtensions

Methods

SaveAsExcel 2 overloads
public static OfficeConversionReport SaveAsExcel(OdsDocument source, string path, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a path and returns the conversion report.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
path string required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsExcel(OdsDocument source, Stream stream, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsExcelAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsExcelAsync(OdsDocument source, string path, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
path string required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsExcelAsync(OdsDocument source, Stream stream, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsOpenDocument 2 overloads
public static OfficeConversionReport SaveAsOpenDocument(ExcelDocument source, string path, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a path and returns the conversion report.

Parameters

source OfficeIMO.Excel.ExcelDocument required
path string required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsOpenDocument(ExcelDocument source, Stream stream, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

source OfficeIMO.Excel.ExcelDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsOpenDocumentAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsOpenDocumentAsync(ExcelDocument source, string path, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

source OfficeIMO.Excel.ExcelDocument required
path string required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsOpenDocumentAsync(ExcelDocument source, Stream stream, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

source OfficeIMO.Excel.ExcelDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToExcel 2 overloads
public static ExcelDocument ToExcel(OdsDocument source, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Converts an ODS spreadsheet to an in-memory workbook; the LossPolicy option rejects loss.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

ExcelDocument
public static ExcelDocument ToExcel(OdsDocument source, ExcelOpenDocumentConversionOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts an ODS spreadsheet to an in-memory workbook; the LossPolicy option rejects loss and returns the completed conversion report.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

ExcelDocument
public static Task<OfficeConversionResult<ExcelDocument>> ToExcelAsync(OdsDocument source, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Converts an ODS spreadsheet to an in-memory workbook; the LossPolicy option rejects loss, returning the value and report together.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<ExcelDocument>>
ToOpenDocument 2 overloads
public static OdsDocument ToOpenDocument(ExcelDocument source, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Converts a workbook to an in-memory ODS spreadsheet; the LossPolicy option rejects loss.

Parameters

source OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OdsDocument
public static OdsDocument ToOpenDocument(ExcelDocument source, ExcelOpenDocumentConversionOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a workbook to an in-memory ODS spreadsheet; the LossPolicy option rejects loss and returns the completed conversion report.

Parameters

source OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

OdsDocument
public static Task<OfficeConversionResult<OdsDocument>> ToOpenDocumentAsync(ExcelDocument source, ExcelOpenDocumentConversionOptions? options = null, CancellationToken cancellationToken = default) #

Converts a workbook to an in-memory ODS spreadsheet; the LossPolicy option rejects loss, returning the value and report together.

Parameters

source OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<OdsDocument>>