Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

AsciiDocMarkdownConverterExtensions

OfficeIMO.AsciiDoc.Markdown

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

Loss-aware conversions between AsciiDoc and Markdown models.

Inheritance

  • object
  • AsciiDocMarkdownConverterExtensions

Methods

SaveAsAsciiDoc 2 overloads
public static OfficeConversionReport SaveAsAsciiDoc(MarkdownDocument document, string path, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes converted AsciiDoc and returns the report, including native evidence.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
path string required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsAsciiDoc(MarkdownDocument document, Stream stream, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes converted AsciiDoc and returns the report, including native evidence.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
stream System.IO.Stream required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsAsciiDocAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsAsciiDocAsync(MarkdownDocument document, string path, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes converted AsciiDoc and returns the report, including native evidence.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
path string required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsAsciiDocAsync(MarkdownDocument document, Stream stream, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes converted AsciiDoc and returns the report, including native evidence.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
stream System.IO.Stream required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsMarkdown 2 overloads
public static OfficeConversionReport SaveAsMarkdown(AsciiDocDocument document, string path, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes converted Markdown and returns the report, including native evidence.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
path string required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsMarkdown(AsciiDocDocument document, Stream stream, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes converted Markdown and returns the report, including native evidence.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
stream System.IO.Stream required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsMarkdownAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(AsciiDocDocument document, string path, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes converted Markdown and returns the report, including native evidence.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
path string required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(AsciiDocDocument document, Stream stream, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes converted Markdown and returns the report, including native evidence.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
stream System.IO.Stream required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToAsciiDoc 2 overloads
public static AsciiDocDocument ToAsciiDoc(MarkdownDocument document, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts into a detached AsciiDoc model.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

AsciiDocDocument
public static AsciiDocDocument ToAsciiDoc(MarkdownDocument document, MarkdownAsciiDocExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts and retains native diagnostic locations and canonical source evidence.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

AsciiDocDocument
public static Task<OfficeConversionResult<AsciiDocDocument>> ToAsciiDocAsync(MarkdownDocument document, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts asynchronously and returns the model and completed report.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<AsciiDocDocument>>
ToMarkdown 4 overloads
public static MarkdownDocument ToMarkdown(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts into a detached Markdown model.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public static MarkdownDocument ToMarkdown(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts and retains native diagnostic locations and canonical source evidence.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public static MarkdownDocument ToMarkdown(AsciiDocBlock block, AsciiDocDocumentAttributes attributes, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a single block using the attributes and reference catalog in effect at that block.

Parameters

block OfficeIMO.AsciiDoc.AsciiDocBlock required
attributes OfficeIMO.AsciiDoc.AsciiDocDocumentAttributes required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public static MarkdownDocument ToMarkdown(AsciiDocBlock block, AsciiDocDocumentAttributes attributes, AsciiDocMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a contextual block while retaining its diagnostics and used footnotes.

Parameters

block OfficeIMO.AsciiDoc.AsciiDocBlock required
attributes OfficeIMO.AsciiDoc.AsciiDocDocumentAttributes required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts asynchronously and returns the model and completed report.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<MarkdownDocument>>