API Reference
WordToHtmlOptions
Options controlling Word to HTML conversion.
Inheritance
- Object
- WordToHtmlOptions
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
Constructors
public WordToHtmlOptions() #Methods
public static WordToHtmlOptions CreateDocumentRoundTripProfile(OfficeVisualThemeKind theme = Report) #WordToHtmlOptionsCreates a trusted editable round-trip export with document structure and private review metadata enabled.
Parameters
- theme OfficeIMO.Drawing.OfficeVisualThemeKind = Report
public static WordToHtmlOptions CreatePrintReviewProfile(OfficeVisualThemeKind theme = WordLike) #WordToHtmlOptionsCreates a print-oriented review export with section, header, footer, and generated print styling.
Parameters
- theme OfficeIMO.Drawing.OfficeVisualThemeKind = WordLike
public static WordToHtmlOptions CreateSemanticDocumentProfile(OfficeVisualThemeKind theme = WordLike) #WordToHtmlOptionsCreates a readable semantic-document export with shared OfficeIMO document styling.
Parameters
- theme OfficeIMO.Drawing.OfficeVisualThemeKind = WordLike
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public WordHtmlExportProfile ExportProfile { get; set; } #Named Word-to-HTML fidelity contract represented by this export.
public OfficeHtmlConversionProfile Profile { get; set; } #Compatibility bridge to the former cross-format profile enum. New code should use ExportProfile so only Word 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 String Title { get; set; } #Optional title override. Null preserves the Word built-in title.
public String Language { get; set; } #Optional language override. Null preserves the Word document language.
public Boolean EmitDocumentShell { get; set; } #Whether to emit a complete HTML document instead of a fragment.
public String NewLine { get; set; } #Newline sequence used between generated document-shell constructs.
public WordTrackedChangeExportPolicy TrackedChangePolicy { get; set; } #Tracked-change view projected into static HTML. Defaults to the final document view.
public WordFieldExportPolicy FieldPolicy { get; set; } #Field representation used by the static HTML export.
public Boolean IncludeDrawingReviewMetadata { get; set; } #Emits inert wrap, anchor, crop, transform, and supported picture-effect metadata for review without claiming browser reconstruction of Word's floating-layout algorithm. Named export profiles enable this; the compatibility default remains false.
public Int64 MaxDocumentElements { get; set; } #Maximum Open XML elements inspected during export. Defaults to 1,000,000.
public Int64 MaxEmbeddedImageBytes { get; set; } #Maximum bytes embedded for one image. Defaults to 64 MiB.
public Int64 MaxTotalEmbeddedImageBytes { get; set; } #Maximum aggregate image bytes embedded into one HTML result. Defaults to 256 MiB.
public Int64 MaxOutputCharacters { get; set; } #Maximum generated HTML characters. Defaults to 64 million.
public Int32 MaxTableNestingDepth { get; set; } #Maximum nested table depth exported from a Word document. The default is 128.
public Int32 MaxListNestingDepth { get; set; } #Maximum list nesting depth exported from a Word document. The default is 128.
public Int32 MaxEquationNestingDepth { get; set; } #Maximum OMML equation nesting depth projected to text or MathML. Defaults to and cannot exceed 256.
public String FontFamily { get; set; } #Optional font family applied to created runs during conversion.
public Boolean IncludeFontStyles { get; set; } #When true, includes run font information as inline styles.
public Boolean IncludeListStyles { get; set; } #When set, includes list style information in generated HTML.
public Boolean IncludeListDefinitions { get; set; } #When true, emits reusable CSS classes and a head stylesheet for Word list definitions. Default is false to preserve the legacy inline/list-attribute output shape.
public Boolean IncludeParagraphClasses { get; set; } #When true, paragraph styles are emitted as CSS classes.
public Boolean IncludeRunClasses { get; set; } #When true, run character styles are emitted as CSS classes.
public Boolean IncludeRunColorStyles { get; set; } #When true, includes run color information as inline styles. Defaults to true for conversion fidelity.
public Boolean IncludeRunHighlightStyles { get; set; } #When true, includes run highlight information as inline styles. Defaults to true for conversion fidelity.
public Boolean IncludeParagraphSpacingStyles { get; set; } #When true, includes paragraph spacing information as inline styles.
public Boolean IncludeParagraphIndentationStyles { get; set; } #When true, includes paragraph indentation information as inline styles.
public Boolean ExportFootnotes { get; set; } #When true, footnotes are exported to HTML. Set to false to omit footnotes.
public Boolean ExportEndnotes { get; set; } #When true, endnotes are exported to HTML. Set to false to omit endnotes.
public Boolean ExportComments { get; set; } #When true, Word comments are exported as linked HTML references and a comments section. Default is false so review metadata is not exposed unless requested.
public Boolean IncludeCustomProperties { get; set; } #When true, custom document properties are exported as typed HTML meta tags. Default is false so callers explicitly choose whether custom metadata is browser-visible.
public Boolean IncludeSectionMetadata { get; set; } #When true, wraps exported document content in per-section section elements that preserve Word page size, orientation, and margin metadata. Default is false to preserve the legacy flat body output.
public Boolean IncludeTableColumnGroups { get; set; } #When true, emits table column width metadata as HTML colgroup and col elements when the Word table exposes usable column widths. Default is false to preserve the legacy row-first table output.
public Boolean EmbedImagesAsBase64 { get; set; } #When true (default), embeds images as base64 data URIs. When false, uses the image file paths instead.
public List<ValueTuple<String, String>> AdditionalMetaTags { get; } #Additional meta tags to include in the HTML head. Each tuple represents the name and content attributes of a meta element.
public List<ValueTuple<String, String>> AdditionalLinkTags { get; } #Additional link tags to include in the HTML head. Each tuple represents the rel and href attributes of a link element.
public Boolean IncludeDefaultCss { get; set; } #When true, injects a small, built-in "Word-like" CSS into the HTML <head> to make output readable out-of-the-box. Default is false to preserve legacy behavior.