Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

HtmlRtfConverterExtensions

OfficeIMO.Html

Edit on GitHub
Namespace
OfficeIMO.Html
Assembly
OfficeIMO.Html.Rtf
Source revision
0eef6a5756b9 with working tree changes
Source
HtmlRtfConverterExtensions.Conversion.cs:10
Modifiers
static

Provides extension methods for converting between RtfDocument and semantic HTML.

Inheritance

  • object
  • HtmlRtfConverterExtensions

Methods

SaveAsHtml 2 overloads
public static OfficeConversionReport SaveAsHtml(RtfDocument document, string path, RtfHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:34

Writes the converted output to a path and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Html.RtfHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(RtfDocument document, Stream stream, RtfHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:41

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Html.RtfHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsHtmlAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(RtfDocument document, string path, RtfHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Html.RtfHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(RtfDocument document, Stream stream, RtfHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Html.RtfHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsRtf 2 overloads
public static OfficeConversionReport SaveAsRtf(HtmlConversionDocument document, string path, HtmlRtfExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:95

Writes the converted output to a path and returns the conversion report.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
path string required
options OfficeIMO.Html.HtmlRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsRtf(HtmlConversionDocument document, Stream stream, HtmlRtfExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:102

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
stream System.IO.Stream required
options OfficeIMO.Html.HtmlRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsRtfAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsRtfAsync(HtmlConversionDocument document, string path, HtmlRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
path string required
options OfficeIMO.Html.HtmlRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsRtfAsync(HtmlConversionDocument document, Stream stream, HtmlRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
stream System.IO.Stream required
options OfficeIMO.Html.HtmlRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToHtml 2 overloads
public static string ToHtml(RtfDocument document, RtfHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:10

Converts an RTF document to semantic HTML text.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Html.RtfHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(RtfDocument document, RtfHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:15

Converts an RTF document to semantic HTML text and returns the completed conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Html.RtfHtmlExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static Task<OfficeConversionResult<string>> ToHtmlAsync(RtfDocument document, RtfHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:27

Converts an RTF document to semantic HTML text, returning the value and report together.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Html.RtfHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>
ToRtf 2 overloads
public static RtfDocument ToRtf(HtmlConversionDocument document, HtmlRtfExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:71

Converts prepared HTML into an RTF document model.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
options OfficeIMO.Html.HtmlRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static RtfDocument ToRtf(HtmlConversionDocument document, HtmlRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:76

Converts prepared HTML into an RTF document model and returns the completed conversion report.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
options OfficeIMO.Html.HtmlRtfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(HtmlConversionDocument document, HtmlRtfExportOptions? options = null, CancellationToken cancellationToken = default) #
HtmlRtfConverterExtensions.Conversion.cs:88

Converts prepared HTML into an RTF document model, returning the value and report together.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
options OfficeIMO.Html.HtmlRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<RtfDocument>>