Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelHtmlConverterExtensions

OfficeIMO.Excel.Html

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

Extension methods enabling HTML conversions for OfficeIMO Excel documents.

Inheritance

  • object
  • ExcelHtmlConverterExtensions

Methods

SaveAsHtml 4 overloads
public static OfficeConversionReport SaveAsHtml(ExcelDocument workbook, string path, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
path string required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(ExcelDocument workbook, Stream stream, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(ExcelSheet sheet, string path, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
path string required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(ExcelSheet sheet, Stream stream, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
stream System.IO.Stream required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsHtmlAsync 4 overloads
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(ExcelDocument workbook, string path, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
path string required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(ExcelDocument workbook, Stream stream, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(ExcelSheet sheet, string path, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
path string required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(ExcelSheet sheet, Stream stream, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
stream System.IO.Stream required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToHtml 4 overloads
public static string ToHtml(ExcelDocument workbook, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a workbook to HTML text.

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(ExcelDocument workbook, ExcelHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a workbook to HTML text and returns the completed conversion report.

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(ExcelSheet sheet, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a worksheet to HTML text.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(ExcelSheet sheet, ExcelHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a worksheet to HTML text and returns the completed conversion report.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
ToHtmlAsync 2 overloads
public static Task<OfficeConversionResult<string>> ToHtmlAsync(ExcelDocument workbook, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a workbook to HTML text, returning the value and report together.

Parameters

workbook OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>
public static Task<OfficeConversionResult<string>> ToHtmlAsync(ExcelSheet sheet, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a worksheet to HTML text, returning the value and report together.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>