Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelOpenDocumentImageExportExtensions

OfficeIMO.Excel.OpenDocument

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

Thin ODS image-export bridge over the Excel visual renderer.

Inheritance

  • object
  • ExcelOpenDocumentImageExportExtensions

Methods

public static OfficeConversionReport SaveAsImages(OdsDocument document, string folderPath, ExcelImageExportOptions? imageOptions = null, ExcelOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected source surfaces through the shared atomic file and fidelity policies.

Parameters

document OfficeIMO.OpenDocument.OdsDocument required
folderPath string required
imageOptions OfficeIMO.Excel.ExcelImageExportOptions? = null optional
conversionOptions OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static async Task<OfficeConversionReport> SaveAsImagesAsync(OdsDocument document, string folderPath, ExcelImageExportOptions? imageOptions = null, ExcelOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected source surfaces asynchronously without retaining earlier encoded payloads.

Parameters

document OfficeIMO.OpenDocument.OdsDocument required
folderPath string required
imageOptions OfficeIMO.Excel.ExcelImageExportOptions? = null optional
conversionOptions OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ToImages(OdsDocument document, ExcelImageExportOptions? imageOptions = null, ExcelOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected source surfaces using the encoding in the image options.

Parameters

document OfficeIMO.OpenDocument.OdsDocument required
imageOptions OfficeIMO.Excel.ExcelImageExportOptions? = null optional
conversionOptions OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static IReadOnlyList<OfficeImageExportResult> ToImages(OdsDocument source, OfficeImageExportFormat format, ExcelImageExportOptions? imageOptions = null, ExcelOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Converts an ODS workbook to Excel semantics and exports selected worksheets.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
imageOptions OfficeIMO.Excel.ExcelImageExportOptions? = null optional
conversionOptions OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static void ToImages(OdsDocument source, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, ExcelImageExportOptions? imageOptions = null, ExcelOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Streams selected ODS worksheet images without retaining earlier payloads.

Parameters

source OfficeIMO.OpenDocument.OdsDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
imageOptions OfficeIMO.Excel.ExcelImageExportOptions? = null optional
conversionOptions OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(OdsDocument document, ExcelImageExportOptions? imageOptions = null, ExcelOpenDocumentConversionOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected source surfaces asynchronously under one shared operation deadline and budget.

Parameters

document OfficeIMO.OpenDocument.OdsDocument required
imageOptions OfficeIMO.Excel.ExcelImageExportOptions? = null optional
conversionOptions OfficeIMO.Excel.OpenDocument.ExcelOpenDocumentConversionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>