API Reference
Class
WordMarkdownConverterExtensions
Extension methods enabling Markdown conversions for WordDocument instances.
Inheritance
- Object
- WordMarkdownConverterExtensions
Methods
SaveAsMarkdown 2 overloads
public static WordToMarkdownResult SaveAsMarkdown(WordDocument document, String path, WordToMarkdownOptions options = null) #Returns:
WordToMarkdownResultSynchronously saves the document as a Markdown file at the specified path.
Parameters
- document OfficeIMO.Word.WordDocument
- The WordDocument to convert to Markdown.
- path System.String
- Destination file path.
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- Optional conversion options.
public static WordToMarkdownResult SaveAsMarkdown(WordDocument document, Stream stream, WordToMarkdownOptions options = null) #Returns:
WordToMarkdownResultSynchronously saves the document as Markdown to the provided stream.
Parameters
- document OfficeIMO.Word.WordDocument
- The WordDocument to convert to Markdown.
- stream System.IO.Stream
- Target stream.
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- Optional conversion options.
SaveAsMarkdownAsync 2 overloads
public static async Task<WordToMarkdownResult> SaveAsMarkdownAsync(WordDocument document, String path, WordToMarkdownOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<WordToMarkdownResult>Asynchronously saves the document as a Markdown file at the specified path.
Parameters
- document OfficeIMO.Word.WordDocument
- The WordDocument to convert to Markdown.
- path System.String
- Destination file path.
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
A task representing the asynchronous save operation.
public static async Task<WordToMarkdownResult> SaveAsMarkdownAsync(WordDocument document, Stream stream, WordToMarkdownOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<WordToMarkdownResult>Asynchronously saves the document as Markdown to the provided stream.
Parameters
- document OfficeIMO.Word.WordDocument
- The WordDocument to convert to Markdown.
- stream System.IO.Stream
- Target stream.
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
A task representing the asynchronous save operation.
public static String ToMarkdown(WordDocument document, WordToMarkdownOptions options = null, CancellationToken cancellationToken = default) #Returns:
StringConverts the document to a Markdown string.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor during conversion.
Returns
Markdown representation of the document.
public static MarkdownDoc ToMarkdownDocument(WordDocument document, WordToMarkdownOptions options = null, CancellationToken cancellationToken = default) #Returns:
MarkdownDocConverts the document into a typed MarkdownDoc without flattening through markdown text first.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor during conversion.
Returns
Typed markdown document.
public static WordToMarkdownResult ToMarkdownDocumentResult(WordDocument document, WordToMarkdownOptions options = null, CancellationToken cancellationToken = default) #Returns:
WordToMarkdownResultConverts the Word document to a typed Markdown document with a structured fidelity report.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Markdown.WordToMarkdownOptions = null
- cancellationToken System.Threading.CancellationToken = default
ToWordDocument 2 overloads
public static WordDocument ToWordDocument(MarkdownDoc markdown, MarkdownToWordOptions options = null, CancellationToken cancellationToken = default) #Returns:
WordDocumentCreates a new Word document directly from a typed MarkdownDoc.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- Typed markdown document to convert.
- options OfficeIMO.Word.Markdown.MarkdownToWordOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor during conversion.
Returns
A new WordDocument instance.
public static WordDocument ToWordDocument(MarkdownDoc markdown, WordDocument templateDocument, MarkdownToWordTemplateOptions options = null) #Returns:
WordDocumentInserts a typed Markdown document into an existing Word template document.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- Typed Markdown document to insert.
- templateDocument OfficeIMO.Word.WordDocument
- Template document to populate.
- options OfficeIMO.Word.Markdown.MarkdownToWordTemplateOptions = null
- Template insertion options.
Returns
The populated template document.
public static MarkdownToWordResult ToWordDocumentResult(MarkdownDoc markdown, MarkdownToWordOptions options = null, CancellationToken cancellationToken = default) #Returns:
MarkdownToWordResultConverts a typed Markdown document to Word with a structured fidelity report.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Word.Markdown.MarkdownToWordOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object