Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordMarkdownConverterExtensions

OfficeIMO.Word.Markdown

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

Extension methods enabling Markdown conversions for WordDocument instances.

Inheritance

  • object
  • WordMarkdownConverterExtensions

Methods

SaveAsMarkdown 2 overloads
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 required
path string required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public 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 required
stream System.IO.Stream required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsMarkdownAsync 2 overloads
public 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 required
path string required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
stream System.IO.Stream required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsWord 2 overloads
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 required
path string required
options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public 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 required
stream System.IO.Stream required
options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsWordAsync 2 overloads
public 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 required
path string required
options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
stream System.IO.Stream required
options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts Word to a Markdown document.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public 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 required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

MarkdownDocument
public 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 required
options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<MarkdownDocument>>
ToWord 2 overloads
public static WordDocument ToWord(MarkdownDocument document, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts Markdown to a Word document.

Parameters

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

Returns

WordDocument
public 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 required
options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
public 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 required
options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<WordDocument>>