Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfMarkdownConverterExtensions

OfficeIMO.Rtf.Markdown

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

Semantic conversion between OfficeIMO RTF and Markdown document models.

Inheritance

  • object
  • RtfMarkdownConverterExtensions

Methods

SaveAsMarkdown 2 overloads
public static OfficeConversionReport SaveAsMarkdown(RtfDocument document, string path, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a path and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsRtf 2 overloads
public static OfficeConversionReport SaveAsRtf(MarkdownDocument markdown, string path, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a path and returns the conversion report.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
path string required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsRtf(MarkdownDocument markdown, Stream stream, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsRtfAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsRtfAsync(MarkdownDocument markdown, string path, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
path string required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsRtfAsync(MarkdownDocument markdown, Stream stream, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToMarkdown 2 overloads
public static MarkdownDocument ToMarkdown(RtfDocument document, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts an RTF document into a Markdown document model.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts an RTF document into a Markdown document model and returns the completed conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts an RTF document into a Markdown document model, returning the value and report together.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<MarkdownDocument>>
ToRtf 2 overloads
public static RtfDocument ToRtf(MarkdownDocument markdown, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a Markdown document into an RTF document model.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static RtfDocument ToRtf(MarkdownDocument markdown, MarkdownRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a Markdown document into an RTF document model and returns the completed conversion report.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(MarkdownDocument markdown, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a Markdown document into an RTF document model, returning the value and report together.

Parameters

markdown OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<RtfDocument>>