Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

HtmlMarkdownConverterExtensions

OfficeIMO.Markdown.Html

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

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 required
path string required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public 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 required
stream System.IO.Stream required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsMarkdownAsync 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 required
path string required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
stream System.IO.Stream required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public 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 required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public 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 required
options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<MarkdownDocument>>