# AdfConverter

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

Class 

`OfficeIMO.Adf`

**Namespace**

`OfficeIMO.Adf`

**Assembly**

`OfficeIMO.Adf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[AdfConverter.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L13)

**Modifiers**

static

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

## Inheritance

- object
- AdfConverter

Filter members 

Show inherited

## Methods

FromHtml 2 overloads

`public static AdfConversionResult<AdfDocument> FromHtml(string html, HtmlMarkdownExportOptions? options = null)` [#](#method-fromhtml-string-officeimo-markdown-html-htmlmarkdownexportoptions)

[AdfConverter.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L94)

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

Parameters

**html string required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional**

Returns

`AdfConversionResult<AdfDocument>`

`public static AdfConversionResult<AdfDocument> FromHtml(string html, HtmlMarkdownExportOptions? options, AdfConversionOptions adfOptions)` [#](#method-fromhtml-string-officeimo-markdown-html-htmlmarkdownexportoptions-officeimo-adf-adfconversionoptions)

[AdfConverter.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L100)

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

Parameters

**html string required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? required**

**adfOptions OfficeIMO.Adf.AdfConversionOptions required**

Returns

`AdfConversionResult<AdfDocument>`

FromMarkdown 4 overloads

`public static AdfConversionResult<AdfDocument> FromMarkdown(string markdown)` [#](#method-frommarkdown-string)

[AdfConverter.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L53)

Converts Markdown text to ADF.

Parameters

**markdown string required**

Returns

`AdfConversionResult<AdfDocument>`

`public static AdfConversionResult<AdfDocument> FromMarkdown(string markdown, AdfConversionOptions options)` [#](#method-frommarkdown-string-officeimo-adf-adfconversionoptions)

[AdfConverter.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L58)

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

Parameters

**markdown string required**

**options OfficeIMO.Adf.AdfConversionOptions required**

Returns

`AdfConversionResult<AdfDocument>`

`public static AdfConversionResult<AdfDocument> FromMarkdown(MarkdownDocument markdown)` [#](#method-frommarkdown-officeimo-markdown-markdowndocument)

[AdfConverter.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L69)

Converts an OfficeIMO Markdown document to ADF.

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

Returns

`AdfConversionResult<AdfDocument>`

`public static AdfConversionResult<AdfDocument> FromMarkdown(MarkdownDocument markdown, AdfConversionOptions options)` [#](#method-frommarkdown-officeimo-markdown-markdowndocument-officeimo-adf-adfconversionoptions)

[AdfConverter.cs:74](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L74)

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

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Adf.AdfConversionOptions required**

Returns

`AdfConversionResult<AdfDocument>`

`public static AdfConversionResult<string> ToHtml(AdfDocument document, MarkdownHtmlExportOptions? htmlOptions = null, AdfConversionOptions? options = null)` [#](#method-tohtml-officeimo-adf-adfdocument-officeimo-markdown-markdownhtmlexportoptions-officeimo-adf-adfconversionoptions)

[AdfConverter.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L39)

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

Parameters

**document OfficeIMO.Adf.AdfDocument required**

**htmlOptions OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null optional**

**options OfficeIMO.Adf.AdfConversionOptions? = null optional**

Returns

`AdfConversionResult<string>`

`public static AdfConversionResult<string> ToMarkdown(AdfDocument document, AdfConversionOptions? options = null)` [#](#method-tomarkdown-officeimo-adf-adfdocument-officeimo-adf-adfconversionoptions)

[AdfConverter.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L24)

Converts an ADF document to Markdown text.

Parameters

**document OfficeIMO.Adf.AdfDocument required**

**options OfficeIMO.Adf.AdfConversionOptions? = null optional**

Returns

`AdfConversionResult<string>`

`public static AdfConversionResult<MarkdownDocument> ToMarkdownDocument(AdfDocument document, AdfConversionOptions? options = null)` [#](#method-tomarkdowndocument-officeimo-adf-adfdocument-officeimo-adf-adfconversionoptions)

[AdfConverter.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Adf/AdfConverter.cs#L13)

Converts an ADF document to the OfficeIMO Markdown object model.

Parameters

**document OfficeIMO.Adf.AdfDocument required**

**options OfficeIMO.Adf.AdfConversionOptions? = null optional**

Returns

`AdfConversionResult<MarkdownDocument>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:B1D07539CDA750AAF4B2043B402138A908B23DBDA82BF03C3FBA375A7A76B170 -->
