ExcelHtmlConverterExtensions
OfficeIMO.Excel.Html
Extension methods enabling HTML conversions for OfficeIMO Excel documents.
Inheritance
- object
- ExcelHtmlConverterExtensions
Methods
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
- path string
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- path string
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static string ToHtml(ExcelDocument workbook, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a workbook to HTML text.
Parameters
- workbook OfficeIMO.Excel.ExcelDocument
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static string ToHtml(ExcelSheet sheet, ExcelHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a worksheet to HTML text.
Parameters
- sheet OfficeIMO.Excel.ExcelSheet
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- options OfficeIMO.Excel.Html.ExcelHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<string>>