RtfMarkdownConverterExtensions
OfficeIMO.Rtf.Markdown
Semantic conversion between OfficeIMO RTF and Markdown document models.
Inheritance
- object
- RtfMarkdownConverterExtensions
Methods
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
- path string
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>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
- path string
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>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
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic 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
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic 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
- options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<MarkdownDocument>>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
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
RtfDocumentpublic 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
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
RtfDocumentpublic 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
- options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<RtfDocument>>