API Reference
Class
HtmlRtfConverterExtensions
Provides extension methods for converting between RtfDocument and semantic HTML.
Inheritance
- Object
- HtmlRtfConverterExtensions
Methods
SaveAsHtml 2 overloads
public static Void SaveAsHtml(RtfDocument document, String path, RtfToHtmlOptions options = null, Encoding encoding = null) #Returns:
VoidSaves an RTF document as semantic HTML at the specified path.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- path System.String
- options OfficeIMO.Html.RtfToHtmlOptions = null
- encoding System.Text.Encoding = null
public static Void SaveAsHtml(RtfDocument document, Stream stream, RtfToHtmlOptions options = null, Encoding encoding = null) #Returns:
VoidSaves an RTF document as semantic HTML to a writable stream.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- stream System.IO.Stream
- options OfficeIMO.Html.RtfToHtmlOptions = null
- encoding System.Text.Encoding = null
SaveAsHtmlAsync 2 overloads
public static async Task SaveAsHtmlAsync(RtfDocument document, String path, RtfToHtmlOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = null) #Returns:
TaskSaves an RTF document as semantic HTML at the specified path.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- path System.String
- options OfficeIMO.Html.RtfToHtmlOptions = null
- encoding System.Text.Encoding = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task SaveAsHtmlAsync(RtfDocument document, Stream stream, RtfToHtmlOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = null) #Returns:
TaskSaves an RTF document as semantic HTML to a writable stream.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- stream System.IO.Stream
- options OfficeIMO.Html.RtfToHtmlOptions = null
- encoding System.Text.Encoding = null
- cancellationToken System.Threading.CancellationToken = null
SaveAsRtf 2 overloads
public static Void SaveAsRtf(HtmlConversionDocument document, String path, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
VoidSaves semantic HTML as an RTF file at the specified path.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- readOptions OfficeIMO.Html.HtmlToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
public static Void SaveAsRtf(HtmlConversionDocument document, Stream stream, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
VoidSaves semantic HTML as RTF to a stream without closing or rewinding the stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- readOptions OfficeIMO.Html.HtmlToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
SaveAsRtfAsync 2 overloads
public static async Task SaveAsRtfAsync(HtmlConversionDocument document, String path, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null, CancellationToken cancellationToken = null) #Returns:
TaskSaves semantic HTML as an RTF file at the specified path.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- readOptions OfficeIMO.Html.HtmlToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task SaveAsRtfAsync(HtmlConversionDocument document, Stream stream, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null, CancellationToken cancellationToken = null) #Returns:
TaskSaves semantic HTML as RTF to a writable stream without closing or rewinding the stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- readOptions OfficeIMO.Html.HtmlToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
- cancellationToken System.Threading.CancellationToken = null
public static String ToHtml(RtfDocument document, RtfToHtmlOptions options = null) #Returns:
StringConverts an RTF document to semantic HTML.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Html.RtfToHtmlOptions = null
public static Byte[] ToHtmlBytes(RtfDocument document, RtfToHtmlOptions options = null, Encoding encoding = null) #Returns:
Byte[]Converts an RTF document to encoded semantic HTML bytes.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Html.RtfToHtmlOptions = null
- encoding System.Text.Encoding = null
public static RtfToHtmlResult ToHtmlResult(RtfDocument document, RtfToHtmlOptions options = null) #Returns:
RtfToHtmlResultExports RTF to semantic HTML and returns structured conversion evidence.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Html.RtfToHtmlOptions = null
public static MemoryStream ToHtmlStream(RtfDocument document, RtfToHtmlOptions options = null, Encoding encoding = null) #Returns:
MemoryStreamConverts an RTF document to an encoded semantic HTML memory stream.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Html.RtfToHtmlOptions = null
- encoding System.Text.Encoding = null
public static String ToRtf(HtmlConversionDocument document, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null) #Returns:
StringConverts semantic HTML to RTF text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- readOptions OfficeIMO.Html.HtmlToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
public static Byte[] ToRtfBytes(HtmlConversionDocument document, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
Byte[]Converts semantic HTML to encoded RTF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- readOptions OfficeIMO.Html.HtmlToRtfOptions = null
- writeOptions OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
public static RtfDocument ToRtfDocument(HtmlConversionDocument document, HtmlToRtfOptions options = null) #Returns:
RtfDocumentLoads a prepared shared HTML conversion document into an RTF document model without reparsing.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlToRtfOptions = null
public static HtmlToRtfResult ToRtfDocumentResult(HtmlConversionDocument document, HtmlToRtfOptions options = null) #Returns:
HtmlToRtfResultImports a prepared shared HTML document into RTF and returns structured evidence.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlToRtfOptions = null
public static MemoryStream ToRtfStream(HtmlConversionDocument document, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #Returns:
MemoryStreamConverts semantic HTML to an encoded RTF memory stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- readOptions OfficeIMO.Html.HtmlToRtfOptions = 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