Class LayoutEngine
Lays out a resolved document into renderer-agnostic page primitives.
public sealed class LayoutEngine
- Inheritance
-
LayoutEngine
- Inherited Members
Remarks
Measured: the frame takes no room in the flow (the next paragraph starts where the framed one would have); it is placed by its anchors and alignment through the anchoring every floating object uses; the text wraps beside it (around, auto), below it (not beside) or under it (none); with no width it is its text's width, with no height its content's, an exact height clips and an at-least height holds it open. Drop caps are laid out as ordinary frames for now (a residue of Phase 169).
Constructors
- LayoutEngine(FontEngine)
Initializes a layout engine using the given font engine.
- LayoutEngine(FontEngine, ITextShaper?)
Initializes a layout engine using the given font engine and text shaper.
Fields
- MaxPagesWithoutSplitRowProgress
How many pages in a row may be started for one table row without any part of the row being placed on them, before the layout is abandoned.
Properties
- Checkpoint
Gets or sets a callback invoked at block, table-row, page and section boundaries during layout. Throwing from it aborts the layout; returning normally continues it.
- DefaultLanguage
Gets or sets a fallback BCP 47 language tag used when the resolved document declares none, or null (the default) to leave the language undeclared.
- EmitFormattingMarks
Gets or sets whether layout emits a LayoutMark where a paragraph or a forced break ends a line and over each tab's gap: Word's formatting marks, for a consumer that shows them. Default false.
- EmitLogicalStructure
Gets or sets a value indicating whether composition emits logical-structure marks for tagged output. Default false.
- EmitSourceReferences
Gets or sets whether each laid-out GlyphRun carries the document text it came from (Source). Default false.
- MaxImagePixelsLimit
Gets or sets an optional ceiling on the pixels of any one bitmap a metafile embeds. Null means no cap.
- MaxNestedTableDepthLimit
Gets or sets an optional hard cap for nested table depth. Null means no caller-configured cap (the engine's built-in compatibility cap still applies).
- MaxPagesLimit
Gets or sets an optional ceiling on the pages layout may start. Null means no cap.
- 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 over the slot's MathSlotRegion. Default false: an empty slot takes no width, as in Word's printed output.
Methods
- Layout(ResolvedDocument, IConversionDiagnostics?)
Lays out a resolved document to pages and positioned primitives.