API Reference
RtfToHtmlOptions
Controls RTF to semantic HTML conversion.
Inheritance
- Object
- RtfToHtmlOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
Accepted by parameters
- Method HtmlRtfConverterExtensions.SaveAsHtml
- Method HtmlRtfConverterExtensions.SaveAsHtml
- Method HtmlRtfConverterExtensions.SaveAsHtmlAsync
- Method HtmlRtfConverterExtensions.SaveAsHtmlAsync
- Method HtmlRtfConverterExtensions.ToHtml
- Method HtmlRtfConverterExtensions.ToHtmlBytes
- Method HtmlRtfConverterExtensions.ToHtmlResult
- Method HtmlRtfConverterExtensions.ToHtmlStream
Constructors
public RtfToHtmlOptions() #Methods
public RtfToHtmlOptions Clone() #RtfToHtmlOptionsCreates a reusable copy of the current save options.
Returns
A new RtfToHtmlOptions with the same configuration values.
public static RtfToHtmlOptions CreatePrintReviewProfile(OfficeVisualThemeKind theme = WordLike) #RtfToHtmlOptionsCreates a complete, styled HTML document for browser and print review. The profile remains static and never enables script execution or remote browser behavior.
Parameters
- theme OfficeIMO.Drawing.OfficeVisualThemeKind = WordLike
public static RtfToHtmlOptions CreateRoundTripProfile() #RtfToHtmlOptionsCreates options for a trusted OfficeIMO HTML round trip. The output can contain private metadata and binary payloads and must not be published without sanitization.
public static RtfToHtmlOptions CreateWebSafeProfile() #RtfToHtmlOptionsCreates options for publishing untrusted RTF as semantic HTML. Private OfficeIMO round-trip metadata and inline data URI images are disabled, and only web and mail hyperlinks are allowed.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public RtfHtmlExportProfile ExportProfile { get; set; } #Named RTF-to-HTML fidelity contract represented by this export.
public OfficeHtmlConversionProfile Profile { get; set; } #Compatibility bridge to the shared profile catalog. New code should use ExportProfile so only RTF profiles are representable.
public OfficeHtmlDocumentOptions DocumentOutput { get; set; } #Composed document-versus-fragment, theme, title, language, style, and newline settings.
public OfficeVisualThemeKind Theme { get; set; } #Compatibility alias for Theme.
public Boolean IncludeDefaultStyles { get; set; } #Compatibility alias for IncludeDefaultStyles.
public Boolean FragmentOnly { get; set; } #Compatibility alias inverse of EmitDocumentShell.
public Boolean IncludeMetadata { get; set; } #Includes document metadata when a full HTML document is requested.
public Boolean PreferEncapsulatedHtml { get; set; } #Prefers Outlook/Exchange HTML encapsulated in the RTF transport over its plain-text fallback. The encapsulated HTML is always reparsed through the bounded HTML reader and current URL policy.
public String Title { get; set; } #Compatibility alias for Title. When unset, the RTF title is used.
public String Language { get; set; } #Language override for the HTML root. Null preserves the RTF document language.
public HtmlUrlPolicy UrlPolicy { get; set; } #URL policy applied to every hyperlink and caller-supplied image source written to HTML. The default is the restrictive web-only policy.
public Boolean IncludeRoundTripMetadata { get; set; } #Includes private data-officeimo-rtf-* metadata used for trusted fidelity round trips. This can include encoded object and image payloads and is disabled by default.
public Boolean EmbedImagesAsDataUri { get; set; } #Embeds supported images as data URI values. Disabled by default for web-safe output.
public Int32 MaxEmbeddedImageBytes { get; set; } #Maximum size of one image that may be embedded as a data URI.
public Func<RtfImage, String> ImageSourceResolver { get; set; } #Optional callback that stores or maps an RTF image and returns its HTML source URL. Returned URLs are validated using UrlPolicy.
public String NewLine { get; set; } #Compatibility alias for NewLine.