WordMarkdownConverterExtensions
OfficeIMO.Word.Markdown
Extension methods enabling Markdown conversions for WordDocument instances.
Inheritance
- object
- WordMarkdownConverterExtensions
Methods
public static OfficeConversionReport SaveAsMarkdown(WordDocument document, string path, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown content with a completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- path string
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsMarkdown(WordDocument document, Stream stream, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown content with a completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsMarkdownAsync(WordDocument document, string path, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown content with a completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- path string
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(WordDocument document, Stream stream, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Markdown content with a completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static OfficeConversionReport SaveAsWord(MarkdownDocument document, string path, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with a completed-stage report.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- path string
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsWord(MarkdownDocument document, Stream stream, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with a completed-stage report.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsWordAsync(MarkdownDocument document, string path, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with a completed-stage report.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- path string
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsWordAsync(MarkdownDocument document, Stream stream, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with a completed-stage report.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static MarkdownDocument ToMarkdown(WordDocument document, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts Word to a Markdown document.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static MarkdownDocument ToMarkdown(WordDocument document, WordMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts Word to Markdown and returns completed-stage findings.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static async Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(WordDocument document, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts Word to Markdown with its completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<MarkdownDocument>>public static WordDocument ToWord(MarkdownDocument document, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #Converts Markdown to a Word document.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic static WordDocument ToWord(MarkdownDocument document, MarkdownWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts Markdown to Word and returns completed-stage findings.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic static async Task<OfficeConversionResult<WordDocument>> ToWordAsync(MarkdownDocument document, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #Converts Markdown to Word with its completed-stage report.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<WordDocument>>