Class
HtmlMarkdownConverterExtensions
OfficeIMO.Markdown.Html
Extension helpers for converting HTML into OfficeIMO.Markdown content.
Inheritance
- object
- HtmlMarkdownConverterExtensions
Methods
SaveAsMarkdown 2 overloads
public static OfficeConversionReport SaveAsMarkdown(HtmlConversionDocument document, string path, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown with completed-stage findings.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsMarkdown(HtmlConversionDocument document, Stream stream, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown with completed-stage findings.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportSaveAsMarkdownAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(HtmlConversionDocument document, string path, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown with completed-stage findings.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(HtmlConversionDocument document, Stream stream, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown with completed-stage findings.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>ToMarkdown 2 overloads
public static MarkdownDocument ToMarkdown(HtmlConversionDocument document, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts prepared HTML to a Markdown document.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static MarkdownDocument ToMarkdown(HtmlConversionDocument document, HtmlMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts prepared HTML to Markdown with completed-stage findings.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static async Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(HtmlConversionDocument document, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts HTML to Markdown and returns the model and report together.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<MarkdownDocument>>