Class ConvertOptions

Namespace

DocWright

Assembly

DocWright.dll

Options for a single Word-document-to-PDF conversion. One conversion = one options instance; the options object is read once at the start of the conversion, so mutating it during a conversion has no effect on that conversion.

public sealed class ConvertOptions

Inheritance

object

ConvertOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConvertOptions()

Properties

DefaultLanguage

Gets or sets the BCP 47 language tag used when the source document declares no document-wide language of its own, or null (the default) to leave it undeclared.

Diagnostics

Gets or sets the sink that receives structured diagnostics, or null to discard them.

FailOnFontSubstitution

Gets or sets a value indicating whether a font substitution detected by the preflight pre-check aborts the conversion with FontResolutionException (true) instead of being reported and degraded (false, the default). Takes precedence over WarnOnFontSubstitution.

FontDirectories

Gets the directories scanned for font files, in priority order, before the operating system font locations.

FontFallbackChain

Gets the ordered font family fallback chain used when a requested font (and Word's implicit substitutions) cannot be resolved.

Limits

Gets the resource caps applied to the conversion.

Metadata

Gets the metadata written into the produced PDF.

Pages

Gets or sets the pages to convert. Defaults to All.

Password

Gets or sets the password used to open an encrypted input document, or null.

Ignored for unencrypted input. An encrypted input with no password raises DocumentEncryptedException, and a wrong one raises InvalidPasswordException; neither message repeats the value.

Progress

Gets or sets an optional progress sink receiving stage and page-boundary updates.

RenderRevisions

Gets or sets a value indicating whether tracked revisions are rendered with revision marks (true) or with all revisions applied silently (false, the default, matching Word's "No Markup" view).

ScriptFallbackFonts

Gets the per-script glyph-level fallback chains. When a resolved font is available but lacks a glyph for a specific codepoint (for example CJK or Arabic text in a Latin-only font), each such cluster is resolved against the chain keyed by the codepoint's UnicodeScript. This is distinct from family-level substitution (a missing font); the rest of a run keeps its resolved font. Empty by default.

SourceFormat

Gets or sets how the input stream is interpreted. Defaults to Auto, which sniffs the stream.

StrictMode

Gets or sets a value indicating whether unsupported content aborts the conversion with UnsupportedFeatureException (true) instead of being reported through Diagnostics and degraded (false, the default).

TaggedPdf

Gets or sets a value indicating whether the PDF carries logical structure (a tagged PDF): a structure tree, marked content, and artifacts for page furniture. Default false.

TextShaper

Gets or sets an optional text shaper override used by layout. When null, DocWright uses the built-in simple shaper from DocWright.Fonts.

WarnOnFontSubstitution

Gets or sets a value indicating whether the preflight pre-check reports each font substitution as a warning through Diagnostics before layout. Default false; the per-run substitution diagnostics and the end-of-conversion summary are emitted regardless.