API Reference
Class
RtfMarkdownConverterExtensions
Semantic conversion helpers between OfficeIMO RTF and Markdown document models.
Inheritance
- Object
- RtfMarkdownConverterExtensions
Methods
SaveAsMarkdown 2 overloads
public static Void SaveAsMarkdown(RtfDocument document, String path, RtfToMarkdownOptions options = null, Encoding encoding = null) #Returns:
VoidWrites an RTF document as Markdown text.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 System.String
- arg3 OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
- arg4 System.Text.Encoding = null
public static Void SaveAsMarkdown(RtfDocument document, Stream stream, RtfToMarkdownOptions options = null, Encoding encoding = null) #Returns:
VoidWrites an RTF document as Markdown to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
- arg4 System.Text.Encoding = null
SaveAsMarkdownAsync 2 overloads
public static Task SaveAsMarkdownAsync(RtfDocument document, String path, RtfToMarkdownOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously writes an RTF document as Markdown to a path.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 System.String
- arg3 OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
- arg4 System.Text.Encoding = null
- arg5 System.Threading.CancellationToken = default
public static Task SaveAsMarkdownAsync(RtfDocument document, Stream stream, RtfToMarkdownOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously writes an RTF document as Markdown to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
- arg4 System.Text.Encoding = null
- arg5 System.Threading.CancellationToken = default
SaveAsRtf 2 overloads
public static Void SaveAsRtf(MarkdownDoc markdown, String path, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
VoidSaves a parsed Markdown document as RTF to a path.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.String
- arg3 OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- arg4 OfficeIMO.Rtf.RtfWriteOptions = null
- arg5 System.Text.Encoding = null
public static Void SaveAsRtf(MarkdownDoc markdown, Stream stream, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
VoidSaves a parsed Markdown document as RTF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.IO.Stream
- arg3 OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- arg4 OfficeIMO.Rtf.RtfWriteOptions = null
- arg5 System.Text.Encoding = null
SaveAsRtfAsync 2 overloads
public static Task SaveAsRtfAsync(MarkdownDoc markdown, String path, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously saves a parsed Markdown document as RTF to a path.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.String
- arg3 OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- arg4 OfficeIMO.Rtf.RtfWriteOptions = null
- arg5 System.Text.Encoding = null
- arg6 System.Threading.CancellationToken = default
public static Task SaveAsRtfAsync(MarkdownDoc markdown, Stream stream, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously saves a parsed Markdown document as RTF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.IO.Stream
- arg3 OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- arg4 OfficeIMO.Rtf.RtfWriteOptions = null
- arg5 System.Text.Encoding = null
- arg6 System.Threading.CancellationToken = default
public static String ToMarkdown(RtfDocument document, RtfToMarkdownOptions options = null) #Returns:
StringConverts an RTF document into Markdown text.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
public static Byte[] ToMarkdownBytes(RtfDocument document, RtfToMarkdownOptions options = null, Encoding encoding = null) #Returns:
Byte[]Converts an RTF document into encoded Markdown bytes.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
- encoding System.Text.Encoding = null
public static MarkdownDoc ToMarkdownDocument(RtfDocument document, RtfToMarkdownOptions options = null) #Returns:
MarkdownDocConverts an RTF document into a Markdown document model.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
public static RtfConversionResult<MarkdownDoc> ToMarkdownDocumentResult(RtfDocument document, RtfToMarkdownOptions options = null) #Returns:
RtfConversionResult<MarkdownDoc>Converts an RTF document into Markdown together with per-operation fidelity diagnostics.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
public static RtfConversionResult<String> ToMarkdownResult(RtfDocument document, RtfToMarkdownOptions options = null) #Returns:
RtfConversionResult<String>Converts an RTF document into Markdown text with per-operation fidelity diagnostics.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
public static MemoryStream ToMarkdownStream(RtfDocument document, RtfToMarkdownOptions options = null, Encoding encoding = null) #Returns:
MemoryStreamConverts an RTF document into a writable Markdown stream positioned at the beginning.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Rtf.Markdown.RtfToMarkdownOptions = null
- encoding System.Text.Encoding = null
public static String ToRtf(MarkdownDoc markdown, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null) #Returns:
StringConverts a parsed Markdown document into RTF text.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
public static Byte[] ToRtfBytes(MarkdownDoc markdown, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
Byte[]Converts a parsed Markdown document into encoded RTF bytes.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
public static RtfDocument ToRtfDocument(MarkdownDoc markdown, MarkdownToRtfOptions options = null) #Returns:
RtfDocumentConverts a Markdown document model into an RTF document.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
public static RtfConversionResult<RtfDocument> ToRtfDocumentResult(MarkdownDoc markdown, MarkdownToRtfOptions options = null) #Returns:
RtfConversionResult<RtfDocument>Converts Markdown into an RTF document together with per-operation fidelity diagnostics.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
public static RtfConversionResult<String> ToRtfResult(MarkdownDoc markdown, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null) #Returns:
RtfConversionResult<String>Converts a parsed Markdown document into RTF text with per-operation fidelity diagnostics.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
public static MemoryStream ToRtfStream(MarkdownDoc markdown, MarkdownToRtfOptions options = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
MemoryStreamConverts a parsed Markdown document into a writable RTF stream positioned at the beginning.
Parameters
- markdown OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Rtf.Markdown.MarkdownToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object