Table of Contents

Namespace DocWright.Dom.Fields

Classes

FieldArgument

One positional argument of a field instruction, or a nested field used as one.

FieldComparison

Word's comparison semantics for conditional fields (ECMA-376 Part 1 §17.16.5.19).

FieldConditional

The comparison shared by IF, COMPARE, SKIPIF and NEXTIF: operand operator operand, taken from an instruction's first three arguments.

FieldDiscovery

Locates fields in a document without evaluating them.

FieldErrors

The result text Word substitutes for a field it cannot evaluate. These strings are part of the rendered document, not diagnostics, so they are reproduced literally.

FieldEvaluationContext

One field being evaluated, and everything a handler may read while evaluating it.

FieldFormatting

Applies a field's result-formatting switches: # numeric pictures, @ date/time pictures and * general formats (ECMA-376 Part 1 §17.16.4).

FieldFormula

The = (formula) field: an arithmetic and comparison expression over numbers, table cell references and bookmarks (ECMA-376 Part 1 §17.16.5.24).

FieldFormulaContext

What a formula expression may reach outside itself: table cells and bookmarks.

FieldHandlerRegistry

An instance-scoped, thread-safe registry of field handlers, following the same pattern as DocumentFormatRegistry.

FieldInstruction

A parsed field instruction: the field name, its positional arguments, its switches and any nested fields (ECMA-376 Part 1 §17.16.5).

FieldKindInfo

The mapping between field instruction names and FieldKind, and the support level of each kind. This table is the source of the field support matrix in COMPAT.md.

FieldNumberText

The number-to-text conversions Word's * general format switches perform: roman numerals, alphabetic counters, ordinals and spelled-out numbers.

FieldRegion

A located field in a document: its instruction, its cached result, where it sits, and the three edits a consumer needs to make to it.

FieldSwitch

One switch of a field instruction — a backslash followed by a character, optionally carrying an argument (ECMA-376 Part 1 §17.16.4).

FieldUpdate

Evaluates the fields of a document or subtree and writes the results back into their field chains.

FieldUpdateOptions

Everything a field update needs from outside the document.

FieldUpdateResult

What one UpdateFields(DomNode, FieldUpdateOptions?) call did.

Interfaces

IFieldHandler

Evaluates one or more field kinds. Hosts implement this to add a field DocWright does not know, or to override one it does, without a change to the core.

Enums

FieldComparisonOperator

The comparison operators an IF, COMPARE, SKIPIF or NEXTIF instruction may use.

FieldKind

The field kinds the DOM field engine recognizes (ECMA-376 Part 1 §17.16.5).

FieldSupport

How far DocWright takes a given field kind.