Table of Contents

Namespace DocWright.Core.Rendering

Classes

ClipPath

Clip stack operation constraining subsequent primitives to an arbitrary path. The rectangle-only ClipRect remains the cheaper choice for axis-aligned clips; this exists for shape outlines that are not rectangles.

ClipRect

Clip stack operation used to constrain subsequent primitives to a rectangle.

FilledRect

A filled rectangle (used for shading and highlights).

GlyphOrientationGeometry

The layout-space geometry of a GlyphOrientation.

GlyphRun

A positioned run of text glyphs on a single baseline.

GlyphRunSource

Where a GlyphRun's text came from in the document it was laid out from.

GradientFill

A gradient interior paint for a VectorPath.

GradientRamp

The colour ramp Word blends the two stops of a DrawingML gradient with (WQ-0037).

ImagePlacement

A positioned image: where a picture goes on the page, how much of its source is cropped away, and a way to open its bytes. Whatever produces the page adds one for every picture it places, and both renderers draw it.

LayoutDocument

Immutable renderer-agnostic layout result: pages and positioned primitives in twips.

LayoutLine

One laid-out line: the line box layout stacked, the paragraph it belongs to and the document text it holds. It draws nothing.

LayoutMark

A non-printing mark: where a paragraph or a forced break ends a line, or where a tab's gap is. It draws nothing.

LayoutPage

One laid-out page.

LayoutPageInfo

What a laid-out page is, as layout decided it: the section that started it, the header and footer variants it calls for, and the number it displays.

LinkRegion

A page region tied to a link target: the clickable area of a hyperlink, or a marker that names a destination or an outline entry at that position. Whatever produces the page adds them as it places content; the PDF renderer turns them into link annotations, destinations and the outline, and a raster has nothing to draw for them. Kind says which of those a region is.

MathRegion

Where an equation was laid out (Phase 165): its box and its baseline. It draws nothing; a consumer that edits or hit-tests equations finds them by it. One per laid-out equation, ahead of the glyphs and rules it draws.

MathSlotRegion

Where a slot of an equation was laid out (Phase 166): its box, its baseline, and where each of its offsets is, so a consumer can draw a caret in an equation and hit-test a point inside one. It draws nothing. Emitted with source references only, after the equation's MathRegion, one per slot laid out (a slot a structure hides, such as a square root's degree, has none; a line of an inline equation broken over lines has one per piece).

PatternFill

A tiled pattern interior paint for a VectorPath: a two-colour 8x8 tile, set or clear, or an 8x8 tile of coverage on a grid of its own.

PlacementTurn

The arithmetic of a turned ImagePlacement that both renderers share, so they turn a picture by the same amount.

RenderOptions

Options controlling how a renderer serializes a laid-out document. This options bag grows additively; the ILayoutRenderer interface itself never changes within a major version.

RuleSegment

A stroked segment (used for underline/strikethroughs and borders).

ShapeRegion

Where a shape is on a page (Phase 164): its frame before it is turned, how it is turned and mirrored, and the document node it was drawn from. A consumer selects, hit-tests and drags a shape with it, without re-deriving the geometry from the paths that draw it.

StructureMark

A logical-structure boundary in paint order: the start or end of one structure element.

TableCellRegion

Where a table cell is on a page: the cell's band in one fragment of its row (a row split over two pages has a region on each), with the document nodes it was laid out from. A consumer maps a point on the page back to a cell, a row or a column border with it (Word's drag to resize, WQ-0119) and reads a row's laid-out height (Distribute Rows) without re-deriving the table's layout.

TextColumnRegion

Where a section's text column is on a page (Phase 150): one per column of each column band (a page's columns, and again from a continuous section break that changes them mid-page). A consumer draws Word's ruler for a multi-column section with it, or maps a point to its column, without re-deriving the layout.

TurnScope

Turns everything drawn between a push and its pop about a point (Phase 181): the text of a turned shape, which Word draws at the shape's angle.

VectorPath

A filled and/or stroked vector path — the primitive shapes and shape groups paint through. Alpha values are in thousandths of a percent (0..100000), matching the DrawingML a:alpha unit and the crop convention on ImagePlacement; a fully transparent paint is omitted rather than drawn.

Structs

GlyphClusterAdvance

One measured cluster advance within a glyph run.

GlyphClusterMap

Logical-to-shaped mapping metadata for one rendered cluster.

GlyphPlacement

Where a shaped glyph sits relative to the pen: the advance the pen moves after it and the offsets it is drawn at, all in twips at the run's size. A combining mark has a zero advance and an offset back over its base; a kerned pair has an advance that is not the glyph's width. Renderers draw the glyph at pen + offset and then move the pen by the advance, along the run's baseline for X and its up direction for Y.

GlyphRunSourceSegment

One piece of a run's text and the document text it came from.

GradientStop

One stop of a GradientFill.

MathCaretStop

Where one offset of an equation's slot is laid out (Phase 166).

VectorPathSegment

One segment of a vector path, in absolute top-down page twips (the RuleSegment convention, not the rect-origin convention of FilledRect). Control points are meaningful only for CubicTo.

Interfaces

ILaidOutDocument

Marker interface for a fully laid-out document: the immutable result of the layout engine, with every element assigned a page and a position in twips. Renderers consume this seam only — they never see the mutable DOM.

ILayoutPrimitive

Marker interface for positioned layout primitives.

ILayoutRenderer

Renders a laid-out document to an output format. The PDF renderer implements this seam today; image renderers (Word-to-Image) plug in tomorrow without core changes.

Enums

FilledRectKind

Logical type of a filled rectangle.

GeneratedContentKind

What produced the text of a run whose source is Generated.

GlyphOrientation

The quarter turn applied to a run's baseline, measured clockwise from upright.

GlyphRunSourceKind

What a GlyphRunSource says about where a run's text came from.

GradientFillKind

How a GradientFill sweeps its stops.

LayoutHeaderFooterVariant

Which of a section's header (or footer) parts a page calls for.

LayoutMarkKind

What a LayoutMark stands for.

LinkRegionKind

What a LinkRegion is: a link to follow, a place a link can go to, or an entry of the document outline.

RuleSegmentKind

What a RuleSegment is, which decides how a renderer puts its thickness on Word's 1/600-inch device grain (WQ-0040, WQ-0054).

StructureRole

The semantic role of a StructureMark, named after the PDF standard structure type it maps to.

TableHeaderScope

The header scope of a TableHeaderCell.

VectorFillRule

How a path's interior is determined.

VectorLineCap

How stroked subpath ends are drawn.

VectorLineJoin

How stroked segments meet.

VectorPathVerb

The drawing verb of one VectorPathSegment.