API Reference
Class
HtmlMarkdownConverterExtensions
Extension helpers for converting HTML into OfficeIMO.Markdown content.
Inheritance
- Object
- HtmlMarkdownConverterExtensions
Methods
SaveAsMarkdown 2 overloads
public static Void SaveAsMarkdown(HtmlConversionDocument document, String path, HtmlToMarkdownOptions options = null, Encoding encoding = null) #Returns:
VoidSaves converted Markdown text to a path.
Parameters
- arg1 OfficeIMO.Html.HtmlConversionDocument
- arg2 System.String
- arg3 OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
- arg4 System.Text.Encoding = null
public static Void SaveAsMarkdown(HtmlConversionDocument document, Stream stream, HtmlToMarkdownOptions options = null, Encoding encoding = null) #Returns:
VoidSaves converted Markdown text to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Html.HtmlConversionDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
- arg4 System.Text.Encoding = null
SaveAsMarkdownAsync 2 overloads
public static Task SaveAsMarkdownAsync(HtmlConversionDocument document, String path, HtmlToMarkdownOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously saves converted Markdown text to a path.
Parameters
- arg1 OfficeIMO.Html.HtmlConversionDocument
- arg2 System.String
- arg3 OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
- arg4 System.Text.Encoding = null
- arg5 System.Threading.CancellationToken = default
public static Task SaveAsMarkdownAsync(HtmlConversionDocument document, Stream stream, HtmlToMarkdownOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously saves converted Markdown text to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Html.HtmlConversionDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
- arg4 System.Text.Encoding = null
- arg5 System.Threading.CancellationToken = default
public static String ToMarkdown(HtmlConversionDocument document, HtmlToMarkdownOptions options = null) #Returns:
StringConverts a shared OfficeIMO HTML conversion document into Markdown text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- Shared HTML conversion document.
- options OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
- Optional conversion options. Default options are used when omitted.
Returns
The rendered Markdown text.
public static MarkdownDoc ToMarkdownDocument(HtmlConversionDocument document, HtmlToMarkdownOptions options = null) #Returns:
MarkdownDocConverts a shared OfficeIMO HTML conversion document into a Markdown document model.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- Shared HTML conversion document.
- options OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
- Optional conversion options. Default options are used when omitted.
Returns
A structural MarkdownDoc representing the converted Markdown.
public static HtmlToMarkdownResult ToMarkdownDocumentResult(HtmlConversionDocument document, HtmlToMarkdownOptions options = null) #Returns:
HtmlToMarkdownResultConverts a shared HTML conversion document into Markdown with operation-scoped evidence.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Markdown.Html.HtmlToMarkdownOptions = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object