Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

AdfConverter

Edit on GitHub
Namespace OfficeIMO.Adf
Assembly OfficeIMO.Adf
Source AdfConverter.cs:13
Modifiers static

Converts ADF through OfficeIMO's canonical Markdown and HTML models.

Inheritance

  • Object
  • AdfConverter

Methods

FromHtml 2 overloads
public static AdfConversionResult<AdfDocument> FromHtml(String html, HtmlToMarkdownOptions? options = null) #
AdfConverter.cs:91
Returns: AdfConversionResult<AdfDocument>

Converts HTML to ADF through OfficeIMO.Html and OfficeIMO.Markdown.Html.

Parameters

html System.String requiredposition: 0
options OfficeIMO.Markdown.Html.HtmlToMarkdownOptions? = null optionalposition: 1
public static AdfConversionResult<AdfDocument> FromHtml(String html, HtmlToMarkdownOptions? options, AdfConversionOptions adfOptions) #
AdfConverter.cs:97
Returns: AdfConversionResult<AdfDocument>

Converts HTML to ADF with caller-configured task identities and destination validation.

Parameters

html System.String requiredposition: 0
options OfficeIMO.Markdown.Html.HtmlToMarkdownOptions? requiredposition: 1
adfOptions OfficeIMO.Adf.AdfConversionOptions requiredposition: 2
FromMarkdown 4 overloads
public static AdfConversionResult<AdfDocument> FromMarkdown(String markdown) #
AdfConverter.cs:53
Returns: AdfConversionResult<AdfDocument>

Converts Markdown text to ADF.

Parameters

markdown System.String requiredposition: 0
public static AdfConversionResult<AdfDocument> FromMarkdown(String markdown, AdfConversionOptions options) #
AdfConverter.cs:58
Returns: AdfConversionResult<AdfDocument>

Converts Markdown text with resource limits, cancellation, task identities and destination validation.

Parameters

markdown System.String requiredposition: 0
options OfficeIMO.Adf.AdfConversionOptions requiredposition: 1
public static AdfConversionResult<AdfDocument> FromMarkdown(MarkdownDoc markdown) #
AdfConverter.cs:66
Returns: AdfConversionResult<AdfDocument>

Converts an OfficeIMO Markdown document to ADF.

Parameters

markdown OfficeIMO.Markdown.MarkdownDoc requiredposition: 0
public static AdfConversionResult<AdfDocument> FromMarkdown(MarkdownDoc markdown, AdfConversionOptions options) #
AdfConverter.cs:71
Returns: AdfConversionResult<AdfDocument>

Converts a Markdown document with caller-configured task identity generation.

Parameters

markdown OfficeIMO.Markdown.MarkdownDoc requiredposition: 0
options OfficeIMO.Adf.AdfConversionOptions requiredposition: 1
public static AdfConversionResult<String> ToHtml(AdfDocument document, HtmlOptions? htmlOptions = null, AdfConversionOptions? options = null) #
AdfConverter.cs:39
Returns: AdfConversionResult<String>

Converts an ADF document to an HTML fragment through OfficeIMO.Markdown.

Parameters

document OfficeIMO.Adf.AdfDocument requiredposition: 0
htmlOptions OfficeIMO.Markdown.HtmlOptions? = null optionalposition: 1
options OfficeIMO.Adf.AdfConversionOptions? = null optionalposition: 2
public static AdfConversionResult<String> ToMarkdown(AdfDocument document, AdfConversionOptions? options = null) #
AdfConverter.cs:24
Returns: AdfConversionResult<String>

Converts an ADF document to Markdown text.

Parameters

document OfficeIMO.Adf.AdfDocument requiredposition: 0
options OfficeIMO.Adf.AdfConversionOptions? = null optionalposition: 1
public static AdfConversionResult<MarkdownDoc> ToMarkdownDocument(AdfDocument document, AdfConversionOptions? options = null) #
AdfConverter.cs:13
Returns: AdfConversionResult<MarkdownDoc>

Converts an ADF document to the OfficeIMO Markdown object model.

Parameters

document OfficeIMO.Adf.AdfDocument requiredposition: 0
options OfficeIMO.Adf.AdfConversionOptions? = null optionalposition: 1