# ExcelHtmlConverterExtensions

Extension methods enabling HTML conversions for OfficeIMO Excel documents.

Class 

`OfficeIMO.Excel.Html`

**Namespace**

`OfficeIMO.Excel.Html`

**Assembly**

`OfficeIMO.Excel.Html`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ExcelHtmlConverterExtensions.Conversion.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L9)

**Modifiers**

static

Extension methods enabling HTML conversions for OfficeIMO Excel documents.

## Inheritance

- object
- ExcelHtmlConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsHtml 4 overloads

`public static OfficeConversionReport SaveAsHtml(ExcelDocument workbook, string path, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtml-officeimo-excel-exceldocument-string-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L33)

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)` [#](#method-saveashtml-officeimo-excel-exceldocument-io-stream-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L40)

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)` [#](#method-saveashtml-officeimo-excel-excelsheet-string-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L94)

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)` [#](#method-saveashtml-officeimo-excel-excelsheet-io-stream-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:101](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L101)

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)` [#](#method-saveashtmlasync-officeimo-excel-exceldocument-string-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

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)` [#](#method-saveashtmlasync-officeimo-excel-exceldocument-io-stream-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

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)` [#](#method-saveashtmlasync-officeimo-excel-excelsheet-string-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

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)` [#](#method-saveashtmlasync-officeimo-excel-excelsheet-io-stream-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

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)` [#](#method-tohtml-officeimo-excel-exceldocument-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L9)

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)` [#](#method-tohtml-officeimo-excel-exceldocument-officeimo-excel-html-excelhtmlexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L14)

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)` [#](#method-tohtml-officeimo-excel-excelsheet-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:70](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L70)

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)` [#](#method-tohtml-officeimo-excel-excelsheet-officeimo-excel-html-excelhtmlexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L75)

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)` [#](#method-tohtmlasync-officeimo-excel-exceldocument-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L26)

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)` [#](#method-tohtmlasync-officeimo-excel-excelsheet-officeimo-excel-html-excelhtmlexportoptions-threading-cancellationtoken)

[ExcelHtmlConverterExtensions.Conversion.cs:87](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Html/ExcelHtmlConverterExtensions.Conversion.cs#L87)

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>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:D4FF5089EAE3E5D55E72A2F81D05FD0264BC23BE05128AB33DAE8F800456E9FB -->
