Table of Contents

Class LayoutSessionOptions

Namespace
DocWright.Layout
Assembly
DocWright.Layout.dll

What a LayoutSession lays out with: the options ResolveOptions and LayoutEngine take for a one-shot layout.

public sealed class LayoutSessionOptions
Inheritance
LayoutSessionOptions
Inherited Members

Constructors

LayoutSessionOptions()

Properties

DefaultLanguage

Gets or sets the language a document that declares none is given.

EmitFormattingMarks

Gets or sets a value indicating whether layout emits formatting marks (LayoutMark: paragraph ends, breaks, tab gaps).

EmitLogicalStructure

Gets or sets a value indicating whether layout emits logical-structure marks (tagged PDF).

EmitSourceReferences

Gets or sets a value indicating whether glyph runs and lines carry their document source. Defaults to true, which an editor needs.

MaxImagePixels

Gets or sets the largest image, in pixels, that is decoded, or null for no limit.

MaxNestedTableDepth

Gets or sets the deepest table nesting laid out, or null for the engine's ceiling.

MaxPages

Gets or sets the most pages a layout may produce, or null for no limit.

RevisionView

Gets or sets which revision view is laid out. Defaults to Final.

ShowHiddenText

Gets or sets a value indicating whether hidden text is laid out, as Word's screen shows it (ShowHiddenText). It may be changed between two layouts of a session: the next one lays out what it changes.

ShowMathPlaceholders

Gets or sets whether an empty slot of an equation is laid out as wide as Word's placeholder (Phase 166), for a consumer that edits equations and draws the placeholder itself. Default false: an empty slot takes no width, as in Word's printed output.

TextShaper

Gets or sets the shaper, or null for the font engine's own.

VerifyAgainstFullLayout

Gets or sets a value indicating whether every Relayout(WordDocument, IReadOnlyCollection<long>?, IConversionDiagnostics?) also lays the document out from scratch and throws when the two differ. For tests and debugging: it costs a full layout per call.

View

Gets or sets the screen view the document is laid out for (View), or null for its pages. It may be changed between two layouts of a session: the next one lays the document out for it.