Skip to content

API reference / Common / Engine types

Engine types ​

The engine's types the API's values are built from — its document model — which the packages don't export, documented so every one in a signature links to a page. Code that has to name one imports it from @docmentis/udoc-wasm.

Interfaces ​

InterfaceDescription
AccessibilityThe 14.9 entries of a property list, which may be combined with others.
AcroFormCheckBoxFieldA check box (§12.7.4.2.3): a button field with neither the Radio nor the Pushbutton flag.
AcroFormChoiceOptionOne item of a choice field's /Opt.
AcroFormComboBoxFieldA combo box (§12.7.4.4): a choice field with the Combo flag.
AcroFormFieldAdditionalActionsA field's /AA (Table 196).
AcroFormFieldFillOne field to fill in: the field id names, and what it is filled with.
AcroFormFieldSharedWhat every field type holds.
AcroFormListBoxFieldA list box (§12.7.4.4): a choice field without the Combo flag.
AcroFormPushButtonFieldA push-button (§12.7.4.2.2): a button field with the Pushbutton flag. It has no value; its caption and icon are its widgets' /MK.
AcroFormRadioButtonFieldA set of radio buttons (§12.7.4.2.4): a button field with the Radio flag, a button to each widget.
AcroFormSignatureFieldA signature field (§12.7.4.5) — held unsigned: its /V, /Lock and /SV aren't.
AcroFormTextFieldA text field (§12.7.4.3).
AnnotationAdditionalActions/AA on an annotation (Table 194) — actions run on its trigger events.
AnnotationAppearance/AP (Table 168) together with /AS.
AnnotationAppearanceCharacteristics/MK (Table 189) — what a widget's appearance is built from. Its icons are form parts, named as content names a nested form: one icon stream often serves several buttons.
AnnotationAppearanceStateOne named appearance state (/On, /Off, …).
AnnotationBorder/Border — [horizontal_radius vertical_radius width dash?].
AnnotationBorderEffect/BE (Table 167) — an effect applied to the border.
AnnotationBorderStyle/BS (Table 166).
AnnotationFlags/F (Table 165), one field per flag bit.
AnnotationIconFit/IF (Table 247) — how a widget's icons are scaled and placed in it.
AnnotationLineEndings/LE on a line or polyline — the ending at each end.
AnnotationMarkupThe entries a markup annotation carries (Table 170).
AnnotationRectDifferences/RD — how far a drawn rectangle sits inside the annotation's rect, per side.
ArtifactAn /Artifact sequence's property list (14.8.2.2.2, Table 363).
CaretAnnotationA caret annotation (Table 180).
CircleAnnotationA circle annotation (Table 177).
ColorA concrete color in the portable (editing-side) model: components interpreted in a [ColorSpaceRef].
ContentControlA content control's own properties (w:sdtPr + w:sdtEndPr) — what the control is, minus what it wraps.
ContentControlBindingw:dataBinding — the custom-XML node a control mirrors.
ContentControlCheckBoxw14:checkbox — the state, and the two glyphs it paints.
ContentControlDatew:date — how a date control formats, and which date it holds.
ContentControlDocPartw:docPartObj / w:docPartList — which building blocks a control offers.
ContentControlListw:comboBox / w:dropDownList — the choices, and the one taken.
ContentControlListItemOne w:listItem: what the user sees, and what the document stores.
ContentControlRepeatingSectionw15:repeatingSection — a region the user can repeat.
ContentControlSymbolOne w14:checkedState / w14:uncheckedState — a glyph in a named face.
CustomXmlWhat a custom XML element is (w:customXml's uri / element plus w:customXmlPr), minus what it wraps.
DefaultAppearanceA default appearance (/DA, §12.7.3.3): the style variable text is set in — a free text's, a redaction's overlay text. A /DA may hold only the operators a text object allows, and a TextRegularRun's styles model every one of them, so it is a run without its text and placement: its font a FontId, not a resource name.
DiagramA diagram: the parts a graphic frame names by id — what ShapeGraphicData::Diagram holds.
FileAttachmentAnnotationA file attachment annotation (Table 184).
FixedPrint/FixedPrint (Table 191).
FormA self-contained, editable graphics-object body shared by every GraphicsObject whose content is a FormObject pointing at this definition.
FormObjectA reference to a Form — a PDF Do invocation site.
FreeTextAnnotationA free text annotation (Table 174).
GraphicsObjectA single addressable item in the document's editing model.
GridCellRefA cell's address in a worksheet grid — its row's and its column's ids, the pair SpreadsheetHit reports and GridCellRange corners are named by.
GroupObjectA lightweight scene-tree wrapper — a marked-content sequence around its children, and a clip / soft-mask scope they share, with its own coordinate space.
ImageObjectAn image painted under the owning [GraphicsObject]'s transform, which maps the image's [0,1]×[0,1] unit square (top-left origin) into the object's local coordinate space.
InkAnnotationAn ink annotation (Table 182).
LineAnnotationA line annotation (Table 175).
LineStyleStroke line geometry — the brush-independent parameters that shape the outline of a stroked path.
LinkAnnotationA link annotation (Table 173).
MovieAnnotationA movie annotation (Table 186). The movie itself is not held.
NonstrokingStyleNon-stroking paint state — the brush that colors a fillable region (path interior, image stencil, shading region) plus the per-fill compositing knobs that vary between the stroke and non-stroke side of a paint op (PDF ca and op).
OptionalContentMembershipPDF Optional Content Membership Dictionary (Section 8.11.2.2).
PaintBevelA bevel (a:bevelT / a:bevelB, CT_Bevel): a preset profile at a given width/height.
PaintBlipAn image reference with its preprocessing effects (a:blip, CT_Blip).
PaintBlipFillAn image fill (a:blipFill, CT_BlipFillProperties).
PaintBlurEffecta:blur (CT_BlurEffect) — a Gaussian blur of the whole shape.
PaintBorderOne edge's border (CT_Border) — its line style, width, color, and the gap to the content it encloses.
PaintCameraThe viewpoint (a:camera, CT_Camera).
PaintColor-
PaintDashStopOne dash stop (a:ds, CT_DashStop): dash length then gap, each a fraction of the line width (1.0 = 100%).
PaintEffectListA bag of named effects (a:effectLst, CT_EffectList), each optional, in the fixed DrawingML child order.
PaintFillOverlayEffecta:fillOverlay (CT_FillOverlayEffect) — a second fill composited over the shape.
PaintGlowEffecta:glow (CT_GlowEffect) — a colored halo around the shape.
PaintGradientFillA gradient fill (a:gradFill, CT_GradientFillProperties).
PaintGradientStopA gradient stop (a:gs, CT_GradientStop): a [PaintColor] at a position.
PaintInnerShadowEffecta:innerShdw (CT_InnerShadowEffect) — a shadow cast inward from the edges.
PaintLightRigThe lighting (a:lightRig, CT_LightRig).
PaintLineA line outline (a:ln, CT_LineProperties). Every field is optional so a partial override (just a width, just a dash) round-trips faithfully.
PaintLineEndAn arrowhead (a:headEnd / a:tailEnd, CT_LineEndProperties).
PaintOuterShadowEffecta:outerShdw (CT_OuterShadowEffect) — a drop shadow behind the shape.
PaintPatternFillA pattern fill (a:pattFill, CT_PatternFillProperties): a [PaintPresetPattern] hatch drawn with a foreground over a background color.
PaintPresetShadowEffecta:prstShdw (CT_PresetShadowEffect) — one of the 20 preset shadows.
PaintReflectionEffecta:reflection (CT_ReflectionEffect) — a fading mirror image below the shape.
PaintRelativeRectA relative rectangle (CT_RelativeRect): each edge an inset expressed as a fraction of the bounding box (1.0 = 100%).
PaintScene3dThe 3-D scene a shape sits in (a:scene3d, CT_Scene3D): a camera and a light rig (the optional a:backdrop is not modeled).
PaintShape3dThe 3-D shape properties (a:sp3d, CT_Shape3D): bevels, extrusion, contour, and material applied to a 2-D shape extruded into 3-D.
PaintSphericalRotationA rotation in spherical coordinates (a:rot, CT_SphereCoords), all in degrees.
PaintSRgbColorAn sRGB color as a hex triplet — the @val of a:srgbClr, decomposed into bytes.
PaintTileA tile (a:tile, CT_TileInfoProperties): offset, scale, flip, and anchor of the repeated image.
Path-
PathClipPDF W / W* clip — a filled region bounded by a path, evaluated under winding_rule.
PathObjectA path painted with an optional fill and/or stroke.
Point-
PolygonAnnotationA polygon annotation (Table 178).
PolyLineAnnotationA polyline annotation (Table 178).
PopupAnnotationA popup annotation (Table 183) — the window a markup annotation's text shows in.
PortableTextEndpointOne end of a flowing DocumentText selection — a text boundary addressed fully across the document: which page, which form use on it when the text is a form's, and the [TextPosition] — its text object and the boundary in it. (ObjectText needs only bare [TextPosition]s because its page is fixed and it edits none of a form's text.)
PresentationTextEndpointOne end of a flowing DocumentText selection — a caret boundary addressed fully across the document: which slide, which text-bearing shape on it, and the model offset within that shape's story. (A ShapeText caret needs only bare offsets because its slide and shape are fixed.)
PrinterMarkAnnotationA printer's mark annotation (§12.5.6.20).
Rect-
RedactAnnotationA redaction annotation (Table 192).
RenderStylePer-paint-op call-uniform compositing state.
RichTextStyleWhat an element sets of the properties rich text may set (Table 225) — each left unset inherits from the element around it. A default style string (/DS) is one too: what a free text's or a rich text field's text starts from.
ScreenAnnotationA screen annotation (Table 187).
ShadingObjectA gradient or mesh painted directly (PDF sh operator).
ShapeA shape (a:sp, CT_Shape): the common autoshape/text-box element — non-visual identity, visual properties, an optional theme style reference, and an optional text body.
ShapeAdjustPointAn adjustable point (a:pos, CT_AdjPoint2D).
ShapeConnectionA connection endpoint (a:stCxn / a:endCxn, CT_Connection).
ShapeConnectionSiteA connection site (a:cxn, CT_ConnectionSite): a point a connector can attach to.
ShapeConnectorA connector (a:cxnSp, CT_Connector): a shape (typically a preset line geometry) whose ends optionally bind to other shapes' connection sites.
ShapeCustomGeometryA custom geometry (a:custGeom, CT_CustomGeometry2D): a guide-driven path outline with its adjust handles, connection sites, and text rect.
ShapeExtentsA non-negative size in points (CT_PositiveSize2D, a:ext and friends; converted from EMU at import).
ShapeFontRefA reference into the theme font scheme (a:fontRef, CT_FontReference).
ShapeFragmentA set of shape-tree nodes lifted from one tree, in the order they were selected — the copy of a Shapes selection. Each carries its full content subtree (a group brings its children).
ShapeGeometryGuideA geometry guide (a:gd, CT_GeomGuide): a named value computed by a formula, in both a:avLst and a:gdLst.
ShapeGeometryRectA geometry rectangle in adjustable coordinates (a:rect, CT_GeomRect).
ShapeGraphicFrameA graphic frame (a:graphicFrame, CT_GraphicalObjectFrame): positions a non-shape graphic — a table, chart, diagram, or OLE object — within the shape tree.
ShapeGraphicFrameLocksWhat a graphic frame forbids (a:graphicFrameLocks, CT_GraphicalObjectFrameLocking): the per-edit locks an editor honors before it lets a user group, select, move or resize the frame.
ShapeGroupA group shape (a:grpSp, CT_GroupShape): nests child [ShapeNode]s under its own transform and child coordinate space.
ShapeGroupPropertiesA group shape's visual properties (a:grpSpPr, CT_GroupShapeProperties): the group's a:xfrm — both its placement and the child coordinate space (a:chOff / a:chExt) the descendants are laid out in — plus its fill and effects.
ShapeMediaThe media an element plays (a:EG_Media in p:nvPr, and p14:media in its p:extLst).
ShapeMediaBookmarkA named point in a [ShapeMedia]'s file (p14:bmk).
ShapeNonVisualPropertiesThe non-visual data of a shape-tree content: its stable identity and the per-application metadata some hosts attach, kept apart from the element's visual properties (geometry, fill, line).
ShapeOleObjectAn OLE object in a graphic frame (p:oleObj, CT_OleObject) — an Excel chart or worksheet, a Visio drawing, embedded in the package or linked to a file outside it.
ShapePathOne outline path (a:path, CT_Path2D).
ShapePictureA picture (a:pic, CT_Picture): an image placed through a blip fill, shaped and positioned like any other shape.
ShapePlaceholder-
ShapePoint-
ShapePolarAdjustHandleA polar adjust handle (a:ahPolar, CT_PolarAdjustHandle).
ShapePresetGeometryA preset shape geometry (a:prstGeom, CT_PresetGeometry2D): a named [ShapePresetGeometryType] plus the adjust values that tune it.
ShapePropertiesA shape's visual properties (a:spPr, CT_ShapeProperties): its a:xfrm placement together with geometry, fill, line, and effects.
ShapeStyleA shape's style references (a:style, CT_ShapeStyle): one reference into each of the theme's four style dimensions.
ShapeStyleMatrixRefA reference into one style-matrix list (CT_StyleMatrixReference, e.g. a:fillRef).
ShapeTransformA shape's transform (a:xfrm, CT_Transform2D): where it sits, how big it is, and its rotation/flip.
ShapeTreeThe shape-tree root — the reusable model root every doc type embeds.
ShapeXyAdjustHandleAn XY adjust handle (a:ahXY, CT_XYAdjustHandle).
Size-
SmartTagWhat a smart tag is (w:smartTag's uri / element plus w:smartTagPr), minus the spans it wraps.
SoundAnnotationA sound annotation (Table 185). The sound itself is not held.
SquareAnnotationA square annotation (Table 177).
StampAnnotationA rubber stamp annotation (Table 181).
StrokingStyleStroking paint state — the brush plus line geometry used to outline a path, and the per-stroke compositing knobs that vary between the stroke and non-stroke side of a paint op (PDF CA and OP).
StructureContentA marked-content sequence that is a content item of a structure element (14.7.5.2).
TableA table (a:tbl / w:tbl): its grid, its rows, and the properties that govern them.
TableBackgroundStyleThe backdrop a pptx table style paints beneath everything (a:tblBg, CT_TableBackgroundStyle) — one themeable fill and one themeable effect, each optional.
TableBorderOne edge's stroke, as both dialects spell it.
TableBordersA table's own edge set (w:tblBorders) — the outside four plus the two interiors that separate its cells.
TableCell3DA cell's 3-D treatment (a:cell3D) — a bevel on its top face, an optional light rig, and the material its surface imitates.
TableCellBordersA cell's edge set — its four sides, its two diagonals, and the interiors a merged region draws inside itself.
TableCellBorderStylea:tcBdr (CT_TableCellBorderStyle) — a pptx style region's eight edges, each themeable.
TableCellMarginsThe padding between a cell's edges and its content, in points.
TableCellPropertiesA cell's own properties (a:tcPr / w:tcPr) — the superset union.
TableCellRefWhere a cell sits in a Table's dense grid: the [TableRowId] of the row it is in and the [TableColumnId] of the grid column it starts in.
TableCellStylea:tcStyle (CT_TableStyleCellStyle) — what one region of a pptx table style says about a cell.
TableColumnOne grid column (a:gridCol / w:gridCol): its identity and its declared width in points.
TableConditionalThe conditional regions Word recorded as applying to a row or cell (w:cnfStyle, CT_Cnf) — twelve flags naming the regions of TablePart other than the whole table.
TableControlCellA cell-level content control (docx w:sdt, CT_SdtCell) — a container wrapping consecutive cells within one row.
TableControlRowA row-level content control (docx w:sdt, CT_SdtRow) — a container wrapping consecutive rows, with the control's own metadata.
TableCustomXmlCellA cell-level custom XML element (docx w:customXml, CT_CustomXmlCell) — a container wrapping consecutive cells.
TableCustomXmlRowA row-level custom XML element (docx w:customXml, CT_CustomXmlRow) — a container wrapping consecutive rows, with the element's own name and attributes.
TableFloatingA floating table's anchoring (w:tblpPr) — where it sits relative to the page, margin, or text, and how far clear of the text it stands.
TableFragmentA rectangular block of cells lifted from one table — the fragment twin of a TableSelection's cell block, and the table arm of CommonFragment.
TableLookWhich conditional regions of a table's style apply (a:tblPr's six flags / w:tblLook).
TablePartStyleWhat one region of a table style says.
TablePartStylesOne [TablePartStyle] per [TablePart], named as the schema names them.
TablePropertiesA table's own properties — the a:tblPr / w:tblPr union.
TableRegularCellOne cell of the dense grid: its merge state on each axis, its properties, and its [TextBody].
TableRegularRowOne row (a:tr / w:tr): its identity, its properties, and its cells.
TableRowPropertiesA row's properties — a:tr@h and the whole of w:trPr.
TableStyleOne named table style.
TextActiveXControlAn ActiveX control embedded in a span (w:control, CT_Control).
TextAnnotationA text (sticky note) annotation (Table 172).
TextBodyThe rich-text body a shape or table cell holds (a:txBody, CT_TextBody): body-level properties and the [TextStory] of paragraphs.
TextBodyPropertiesBody-level layout properties (a:bodyPr, CT_TextBodyProperties) — anchor, insets (lIns/rIns/tIns/bIns), wrap, autofit, and columns. What it does not model yet is listed after the last field.
TextBookmarkEndA bookmark's closing mark (w:bookmarkEnd, CT_MarkupRange) — one unit, naming the bookmark it closes by id.
TextBookmarkStartA bookmark's opening mark (w:bookmarkStart, CT_Bookmark) — one unit, carrying the name.
TextBreaka:br / w:br — an explicit break within the paragraph. One unit.
TextClipGlyph-outline clip accumulated from text rendered under PDF Tr 4–7. The geometry is the same as a TextRegularRun would have laid out — same TextStyle snapshot, same positioning fields. TextStyle::render_mode, knockout, and leading are inert here (clips don't paint and don't advance to a next line), but they're carried because they're part of the text-state snapshot the gs captured at the BMC site.
TextComplexFieldA field spelled with a field code: w:fldChar+w:instrText, or w:fldSimple.
TextComplexFieldEndA complex field's closing mark — one unit, closing the innermost open field.
TextComplexFieldStartA complex field's opening mark — one unit, carrying the definition.
TextControlBlockA block-level structured document tag / content control (docx w:sdt, CT_SdtBlock) — a container of nested blocks, contributing no characters of its own.
TextControlSpanA span-level structured document tag / content control (docx w:sdt, CT_SdtRun) — the same construct as TextControlBlock at the level below, wrapping spans rather than blocks.
TextCustomXmlBlockA block-level custom XML element (docx w:customXml, CT_CustomXmlBlock) — a container of nested blocks, contributing no characters of its own.
TextCustomXmlSpanA span-level custom XML element (docx w:customXml, CT_CustomXmlRun) — the same construct as TextCustomXmlBlock at the level below, wrapping spans rather than blocks.
TextDrawingA drawing embedded in a span (docx w:drawing, or the legacy w:pict) — an image, shape, chart, diagram or group placed in the text flow.
TextDrawingEffectExtentHow far a drawing's effects reach past its extent (wp:effectExtent, CT_EffectExtent), in points on each edge.
TextDrawingWrapDistanceHow far text keeps clear of a drawing on each edge (distT / distB / distL / distR, ST_WrapDistance), in points.
TextEastAsianLayoutEast Asian layout (w:eastAsianLayout / @kumimoji) — the character-fitting features for CJK text.
TextEmbeddedObjectAn embedded foreign object in a span (docx w:object) — an OLE embedding or link (a Visio drawing, an Excel range, an Equation 3.0 formula) or an ActiveX control.
TextFloatingHorizontalPositionwp:positionH — where a floating drawing sits across the page: what the position is measured from, and where within that it lands.
TextFloatingPlacementEverything wp:anchor adds over wp:inline: where the drawing is placed, what the text does around it, and the behavior flags that decide stacking and overlap.
TextFloatingVerticalPositionwp:positionV — where a floating drawing sits down the page, the vertical twin of [TextFloatingHorizontalPosition].
TextFloatingWrapPolygonThe contour a tight or through wrap follows (wp:wrapPolygon, CT_WrapPath).
TextFormFieldw:ffData — a form field's state: what it is called, how it behaves, and what the user has put in it.
TextFragmentA sequence of story content to splice in — an ordered list of blocks whose boundary paragraphs fuse into the splice site.
TextGroupRunA marked-content sequence begun and ended inside a text block around none or several runs — one /P <</MCID n>> per paragraph, say.
TextHyperlinkThe link a span's text or a shape-tree element follows — where it points, what following it does, its tooltip, and how it is followed.
TextLanguageThe span's language tags (w:lang / a:rPr@lang + @altLang) — BCP-47 tags such as "en-US" or "ja-JP", one per script slot.
TextLigaturesThe optional ligatures a span is set with (w14:ligatures, MS-DOCX 2.6.1.17) — four independent kinds, each the OpenType feature the shaper turns on. docx-only; DrawingML has no counterpart. ST_Ligatures (MS-DOCX 2.6.4.3) spells every combination of the four as one value: standardContextual is standard and contextual, none all four off.
TextListStyleA per-level set of paragraph defaults (CT_TextListStyle) — nine [TextParagraphProperties], one per outline level, over a default layer that sits beneath them all.
TextMarkedContentPointA marked-content point (MP or DP) inside a text block.
TextMarkupAnnotationA highlight, underline, squiggly-underline, or strikeout annotation (Table 179).
TextMathAn equation in a text story (OMML m:oMathPara or m:oMath) — the text model's embedding point for the math sub-domain (its own domain, like chart / diagram).
TextNumberingLevelOne numbering level definition — how the bullet/number for a paragraph renders.
TextObjectA text object: the items of one BT…ET block in stream order — show ops, the marked-content sequences around them, and marked-content points.
TextOleObjectAn OLE object's binding (CT_ObjectEmbed, o:OLEObject).
TextParagraphA paragraph (a:p, CT_TextParagraph): its paragraph-level properties, the character properties of its paragraph mark, and the spans that carry the content.
TextParagraphBordersA paragraph's six border edges (w:pBdr, CT_PBdr), each the character side's [PaintBorder]. An absent edge draws nothing.
TextPositionA position in a page's text: a codepoint offset into show op run of the text object object.
TextRegulara:r (CT_RegularTextRun) — a styled run of text: the paragraph's text leaf. Its span is the text's codepoint length.
TextRegularRunOne text-showing operator — Tj, TJ, ' or " — of a TextObject, placed by its own text matrix.
TextSimpleFieldA field spelled as one self-contained element: a:fld in DrawingML, w:pgNum and the date six in wordprocessing.
TextSmartTagSpanA smart tag (docx w:smartTag, CT_SmartTagRun) — a container of spans, contributing no characters of its own.
TextStoryThe story a text body holds: its stable [TextStoryId], the ordered [TextBlock]s, and the offset root the editing API (insert_at / delete_range / set_property_range) addresses.
TextStylePDF text-state operators grouped into one struct — Tf, Tc, Tw, Tz, TL, Tr, Ts, Tk.
TextTabw:tab — an explicit tab. One unit. Wordprocessing-only; DrawingML uses a literal tab char in a Regular span instead.
TextTableA block-level table in a text story (docx w:tbl) — the text model's embedding point for the table sub-domain, mirroring how a GraphicFrame embeds a table in the shape tree.
TextTabStopOne tab stop (CT_TextTabStop / CT_TabStop): where a tab jumps, how the following text aligns there, and what fills the gap.
TextUnderlineAn underline (u / a:uLn / a:uFill / w:u) — its style pattern plus the DrawingML-split stroke and fill.
TextWarpA preset text warp (a:prstTxWarp, CT_PresetTextShape): a named [TextWarpPresetType] plus the adjust values that tune it — the text counterpart of ShapePresetGeometry.
ThreeDAnnotationA 3D annotation (Table 298). The 3D stream and views are not held.
TransparencyGroupPDF transparency-group attributes carried on a Form XObject's /Group dictionary.
WatermarkAnnotationA watermark annotation (Table 190).
WidgetAnnotationA widget annotation (Table 188) — a form field's appearance on the page. The field it belongs to names it (AcroFormFieldShared::widgets).
WordprocessingTextEndpointOne end of a flowing DocumentText selection — a boundary in a section's body, addressed fully across the document. (SectionText needs only a bare [TextSelection] because its section is fixed.)
XmlAttributeOne attribute carried by a foreign XML element (w:attr, CT_Attr) — shared by CustomXml and SmartTag, whose property elements each hold a list of these and little else.

Type Aliases ​

Type AliasDescription
AcroFormFieldA terminal field (Table 220): one with a type, a value and widgets — one of the seven types a field's /FT and its type's /Ff bits say it is (§12.7.4). Each derefs to what they all hold.
AcroFormFieldValueWhat a field is filled with, by its type. A push-button has no value, and a signature field is signed, not filled in.
ActionWhat activating a link or widget does (§12.6.4), one variant per action type (Table 198).
ActionHideTargetOne of the annotations a Hide action shows or hides (Table 214).
AlignFrame-
AnnotationAppearanceStreamsOne entry of /AP: a single appearance, or a set of named states.
AnnotationBorderStyleKind/BS /S.
AnnotationCaptionPosition/CP on a line annotation.
AnnotationCommandAn edit intent on one page's annotations — the page is the EditAnnotation wrapping it. Annotations are addressed by id; ids not on the page are skipped.
AnnotationHighlightMode/H — what a link or widget shows while pressed.
AnnotationIconScaleType/IF /S — how an icon is scaled.
AnnotationIconScaleWhen/IF /SW — when an icon is scaled to fit.
AnnotationLineEndingA line ending style (Table 176).
AnnotationMarkupIntent/IT — what a markup annotation is for: the values each subtype's table lists (Tables 174, 175 and 178; Stamp, StampImage and StampSnapshot are PDF 2.0's).
AnnotationReplyType/RT.
AnnotationTextJustification/Q — how text is justified.
ArtifactSubtypeA pagination artifact's /Subtype.
ArtifactTypeAn artifact's /Type.
BlendModeCompositing blend mode.
BrushThe source of color used to fill or stroke a shape (PDF editing model).
CallErrorWhy a session refused a call.
CaretSymbol/Sy — the symbol a caret annotation shows (Table 180).
ChartExSpaceId-
ChartSpaceId-
ClipA clipping region.
ColorSpaceId-
ColorSpaceRefA reference to a color space — either a built-in device/sRGB space or a registered non-device space looked up via ColorSpaceId.
ContentControlAppearancew15:appearance (ST_SdtAppearance) — the chrome a control draws.
ContentControlCalendarw:calendar (ST_CalendarType) — the calendar a date is expressed in.
ContentControlDateStoragew:storeMappedDataAs (ST_SdtDateMappingType) — the form a bound date takes in the custom XML part.
ContentControlKindThe type element in w:sdtPr, and the per-type state that rides with it.
ContentControlLockw:lock (ST_Lock) — what a control protects.
ErrorKindWhat a caller can do about a failure: one kind per thing it does differently. Every finer distinction — which part, which offset, which id — is the message.
FileAttachmentIconA file attachment annotation's icon (Table 184).
FontId-
FooterId-
GraphicsObjectContentWhat a [GraphicsObject] paints.
GraphicsObjectId-
GridCharWidthA column width in OOXML character units — the count of maximum-digit-width characters that fit across the column, from <col @width> / <sheetFormatPr @defaultColWidth>.
GridColumnId-
GridColumnWidthA column-resize input width, in either of two units. The wire form lets a host express a ResizeColumns in whichever unit it has to hand: the model's stored Chars (character units), or Points — the natural unit for a header-boundary pixel drag, which the host derives from the viewport scale. Execution converts a Points width to the stored [GridCharWidth] against the sheet's MDW; a Chars width is stored verbatim. (Row heights are already points — [GridRowHeight] — so they need no such wrapper.)
GridRowHeightAn explicit row height in points. Absent (None on [GridRow::height]) means the sheet default applies.
GridRowId-
HeaderId-
ImageCommandAn edit intent for an image document. The editor turns a command into a CRDT modification; it never touches the model directly.
ImageId-
ImageSearchScopeThe part of an image a search covers — the image [SearchScope]. An image holds no text, so a search over it finds nothing.
ImageSelectionThe (always empty) selection of an image document's editor.
LineCap-
LineJoin-
MarkedContentThe tag and property list of one marked-content sequence or point.
MarkupOne wrapper of the markup family, whichever kind it is.
ObjectAlignEdgeThe edge (or center line) an AlignObjects gesture pulls each object's bounding box to within the reference rectangle.
ObjectAlignTargetThe reference an AlignObjects aligns to.
ObjectAxisThe axis a FlipObjects / DistributeObjects gesture acts along.
ObjectCommandAn edit intent on one page's graphics objects — the page is the EditObject wrapping it. Objects are addressed by id; ids not on the page are skipped.
ObjectTextCommandAn edit intent on a page's text, its positions in the paragraphs the layout derives (DerivedTextBlock), which flow in their boxes (DerivedTextBox).
ObjectZOrderA z-order gesture for ReorderObjects. Paint order is the sibling list's order (first painted first), so the last object is on top.
OptionalContentA single optional-content scope: what an /OC sequence holds, or an image or form whose own /OC it is.
OptionalContentGroupId-
OverprintModeOverprint mode controlling how source colors interact with the backdrop during a paint operation marked overprint-enabled.
PageEdgeA page edge an artifact is attached to.
PageId-
PaintBevelTypeBevel profile (ST_BevelPresetType, the @prst of a:bevelT / a:bevelB).
PaintBlendModeCompositing mode for a fill overlay (ST_BlendMode, the @blend of a:fillOverlay).
PaintBlipEffectAn image transform on a [PaintBlip] — one of CT_Blip's effect children.
PaintBlipFillModeTile vs. stretch for a [PaintBlipFill] — the a:tile / a:stretch choice.
PaintBlipSourceWhere a blip's image comes from — the a:blip relationship attributes.
PaintBorderStyleThe line pattern of a [PaintBorder] (ST_Border).
PaintCameraPresetPreset camera position/projection (ST_PresetCameraType, the @prst of a:camera).
PaintColorBaseThe base of a [PaintColor] — one of the six DrawingML color choices (the EG_ColorChoice member elements), or SpreadsheetML's indexed one.
PaintColorTransformA single color transform — one child element of the EG_ColorTransform group.
PaintCompoundLineCompound (multi-stroke) line type (ST_CompoundLine, the @cmpd of a:ln).
PaintFillA fill: how a shape, line, text, or background is painted.
PaintGradientShadeLinear vs. path shading for a [PaintGradientFill] — the a:lin / a:path choice.
PaintLightDirectionLight-rig pointing direction (ST_LightRigDirection, the @dir of a:lightRig).
PaintLightRigTypePreset light arrangement (ST_LightRigType, the @rig of a:lightRig).
PaintLineCapLine end-cap style (ST_LineCap, the @cap of a:ln).
PaintLineDashA dash pattern — the EG_LineDashProperties choice.
PaintLineEndSizeArrowhead size step (ST_LineEndWidth / ST_LineEndLength, the @w / @len of a line end).
PaintLineEndTypeArrowhead shape (ST_LineEndType, the @type of a line end).
PaintLineJoinThe corner join of a stroke — the EG_LineJoinProperties choice.
PaintPathShadeThe radiation pattern of a path gradient (ST_PathShadeType, the @path of a:path).
PaintPenAlignmentPen alignment relative to the path (ST_PenAlignment, the @algn of a:ln).
PaintPresetColorA named preset color (ST_PresetColorVal, the @val of a:prstClr) — each a fixed sRGB value.
PaintPresetDashA preset dash pattern (ST_PresetLineDashVal, the @val of a:prstDash).
PaintPresetMaterialSurface material (ST_PresetMaterialType, the @prstMaterial of a:sp3d).
PaintPresetPatternA preset hatch pattern (ST_PresetPatternVal, the @prst of a:pattFill). The token differs from the variant name, so each is annotated.
PaintRectAlignA nine-point anchor (ST_RectAlignment) — first-tile origin for a tiled fill, and shadow/effect alignment.
PaintSchemeColorA slot referenced by schemeClr (ST_SchemeColorVal) — the abstract names a styled object uses, resolved through the consumer's color map to a ThemeColorScheme slot.
PaintSystemColorA system color slot (ST_SystemColorVal, the @val of a:sysClr) — the Win32 GetSysColor palette. Carried with a @lastClr fallback on [PaintColorBase::System].
PaintTileFlipHow a tiled fill or gradient mirrors as it repeats (ST_TileFlipMode).
PathSegment-
PatternId-
PortableSearchScopeThe pages a PDF search covers — the portable [SearchScope].
PortableSelectionThe selection of a portable document's editor — presence state beside the CRDT, never in it (see [Selection]).
PresentationSearchScopeThe slides a presentation search covers — the presentation [SearchScope].
PresentationSelectionThe selection of a presentation document's editor — presence state beside the CRDT, never in it (see [Selection]).
PropertyListA property list (14.6.2) as written, its entries in order.
PropertyValueA value in a [PropertyList].
RawIdDocument entity id as a replica-counter hex key (e.g. "3a-1").
RenderingIntentRendering intent — the ICC color reproduction strategy used when converting a paint's source color space into the destination.
RichTextFontStretchfont-stretch — how narrow or wide a face of its family the text is set in.
ScriptCategoryThe font-slot category a character's script maps to — the three typeface slots office text selects between.
SectionId-
ShapeAdjustAngleAn adjustable angle (ST_AdjAngle): either a literal in degrees or a reference to a guide by name.
ShapeAdjustCoordinateAn adjustable coordinate (ST_AdjCoordinate): either an EMU literal or a reference to a guide by name.
ShapeAdjustHandleAn adjust handle — the a:ahXY / a:ahPolar choice in a:ahLst.
ShapeAlignEdgeThe edge (or center line) an AlignShapes gesture pulls each node's bounding box to within the reference rectangle.
ShapeAxisThe axis a FlipShapes / DistributeShapes gesture acts along.
ShapeFontCollectionIndexWhich theme font collection a [ShapeFontRef] selects (ST_FontCollectionIndex, the @idx of a:fontRef).
ShapeGeometryA shape's outline — the a:prstGeom / a:custGeom choice.
ShapeGraphicDataWhat a frame hosts (a:graphicData), dispatched by its @uri.
ShapeMediaKindThe kind of a [ShapeMedia] — the a:EG_Media choice.
ShapeNodeAn addressable shape-tree node — the EG_ShapeElement-style choice of what a shape tree holds, one variant per element kind.
ShapeNodeId-
ShapeOleBindingWhere a [ShapeOleObject]'s data lives (p:embed / p:link).
ShapeOleColorSchemeWhat of the colour scheme an embedded OLE object's server is handed (@followColorScheme, ST_OleObjectFollowColorScheme).
ShapePathCommandOne path drawing command — a child element of a:path.
ShapePathFillModeHow a custom path is filled (ST_PathFillMode, the @fill of a:path).
ShapePlaceholderOrientationThe text-flow orientation of a [ShapePlaceholder] (ST_Direction).
ShapePlaceholderSizeThe relative size hint of a [ShapePlaceholder] (ST_PlaceholderSize).
ShapePlaceholderTypeThe kind of a [ShapePlaceholder] (ST_PlaceholderType).
ShapePresetGeometryTypeA built-in preset shape (ST_ShapeType, the @prst of a:prstGeom).
ShapeSelectionWhat is selected within one shape tree — object(s), or a caret / range inside one shape's text.
ShapeZOrderA z-order gesture for ReorderShapes. Paint order is the sibling list's order (first painted first), so the last child is on top.
SheetId-
SlideId-
SlideLayoutId-
SoundIconA sound annotation's icon (Table 185).
SpreadsheetCommandAn edit intent for a spreadsheet document. The editor turns a command into a CRDT modification; it never touches the model directly.
SpreadsheetSearchScopeThe sheets a workbook search covers — the spreadsheet [SearchScope].
SpreadsheetSelectionThe selection of a spreadsheet document's editor — presence state beside the CRDT, never in it (see [Selection]).
StampIconA rubber stamp annotation's icon (Table 181).
StandardFontOne of the 14 standard fonts (§9.6.2.2) — the font a host adds with AddStandardFont, and a font list entry's standard.
StartErrorWhy a session could not be started.
TableAlignmentHow a table sits across the text column (w:jc).
TableCellOne cell of a TableRegularRow — what OOXML lets sit directly inside w:tr, where a cell may sit.
TableCellMergeHow a cell merges along one axis.
TableColumnId-
TableCommandAn edit intent for a table. The embedding doc type's editor turns one into container writes (via execute); it never touches the model directly.
TableId-
TableLayoutWhether the declared grid is authoritative (w:tblLayout).
TableOverlapWhether a floating table may overlap another (w:tblOverlap).
TableRowOne row of a Table — what OOXML lets sit directly inside w:tbl, where a row may sit.
TableRowHeightHow tall a row is (a:tr@h, w:trHeight + @w:hRule), in points.
TableRowId-
TableSelectionWhat is selected inside one table — a block of cells, whole rows or columns, the whole table, or a caret / range in one cell's text.
TableStyleIdA table style's id — the key a table's style names.
TableStyleRefHow a table names its style.
TableThemeableEffectEG_ThemeableEffectStyle — a literal a:effect, or an a:effectRef into the style matrix's a:effectStyleLst.
TableThemeableFillEG_ThemeableFillStyle — a literal a:fill, or an a:fillRef into the style matrix's a:fillStyleLst.
TableThemeableLineCT_ThemeableLineStyle — a literal a:ln, or an a:lnRef into the style matrix's a:lnStyleLst.
TableWidthA declared width (CT_TblWidth), in points or as a fraction.
Text3dHow a body's text stands in 3-D — the EG_Text3D choice on a:bodyPr.
TextAnchorVertical anchoring of a body's content in its frame (ST_TextAnchoringType / w:vAlign).
TextAutoFitThe frame/text fit negotiation (a:noAutofit / a:normAutofit / a:spAutoFit).
TextBaselineAlignSuper/subscript vertical positioning (a:rPr@baseline / w:vertAlign) — distinct from the raw baseline_offset (w:position), which is a signed point shift.
TextBlockOne block in a TextStory.
TextBreakKindWhich flow a [TextBreak] advances (docx w:br@type).
TextCharacterProperties-
TextCharacterPropertyOne specified character property — a [TextCharacterPropertyKey] carrying its value. The value-bearing twin of the key: set takes one, iter yields them, and the Loro mark builder maps each to a (key, value). The large structured values (the fill group, underline, outline, effects, and the docx boxes) are boxed to keep the enum — and every enum that carries it — small.
TextCharacterPropertyKeyA [TextCharacterProperties] property, named without its value — the sort / lookup / clear identity, the [TextCharacterProperty::key] projection, and the key the ClearCharacterProperties operation and the Loro marks carry. One variant per property, in the property order the sparse set sorts by.
TextCharacterStyleIdA character style reference (w:rStyle) — the id of the named character style a span inherits from.
TextChunkA piece of a show-text operation: either glyph bytes to paint or a horizontal adjustment.
TextCombineBracketsThe bracket style around combined East Asian characters (@combineBrackets / ST_CombineBrackets).
TextCommandAn edit intent for a text story. The embedding doc type's editor turns one into LoroText writes (via execute) over the story's container; it never touches the model directly.
TextComplexFieldKindWhat a TextComplexField is — a payload-free tag, and the dispatch key a field pass evaluates on.
TextDatePartOne component of the current date — what a wordprocessing shortcut element paints.
TextDateTimeFormatOne of a:fld's date-time formats — a whole date, rendered as the type asked.
TextDirectionThe direction text flows (w:textDirection@val, ST_TextDirection; and a:bodyPr@vert / a:tcPr@vert, ST_TextVerticalType).
TextDrawingCommandAn edit intent for one TextDrawing — the w:drawing at a slot in a story.
TextDrawingPlacementHow a drawing meets the text around it — w:drawing's own choice of wp:inline or wp:anchor.
TextEmbeddedObjectBindingWhat a [TextEmbeddedObject]'s presentation stands in for.
TextEmphasisMarkThe East Asian emphasis mark (ST_Em / w:em) — dots or circles set beside each glyph for emphasis. docx-only; DrawingML has no counterpart.
TextFloatingHorizontalAlignmentWhere a floating drawing lands within its horizontal origin — the file's choice of wp:align or wp:posOffset, as one value.
TextFloatingHorizontalOriginWhat a horizontal position is measured from (wp:positionH/@relativeFrom, ST_RelFromH).
TextFloatingVerticalAlignmentWhere a floating drawing lands within its vertical origin, the twin of [TextFloatingHorizontalAlignment].
TextFloatingVerticalOriginWhat a vertical position is measured from (wp:positionV/@relativeFrom, ST_RelFromV).
TextFloatingWrapWhat the text does around a floating drawing — the file's five wrap elements, which are a choice of exactly one.
TextFloatingWrapSideWhich sides of a floating drawing text runs down (@wrapText, ST_WrapText).
TextFontA span's typeface reference — a concrete face name or a theme font slot.
TextFontAlignWhere a glyph's font box sits on its line (a:pPr@fontAlgn / w:textAlignment@val) — how runs of different sizes line up against each other.
TextFormFieldKindThe three form fields, each with the state only it has.
TextFormInputKindw:textInput@type (ST_FFTextType) — what a text form field accepts.
TextHyperlinkActionWhat following a [TextHyperlink] does — a:hlinkClick@action, one variant per value PowerPoint reserves (MS-OI29500 §2.1.1395), each holding the parameters its value spells.
TextHyperlinkShowJumpWhere a [TextHyperlinkAction::ShowJump] moves — jump= of ppaction://hlinkshowjump.
TextHyperlinkTargetA [TextHyperlink]'s destination.
TextIconA text annotation's icon (Table 172).
TextLineSpacingA paragraph's line spacing rule (a:lnSpc / w:spacing@line + @lineRule) — the three Word models. Unspecified defaults to single spacing, Percent(1.0).
TextMatrixOriginHow a [TextRegularRun]'s (or Clip::Text's) text_matrix came to be: explicitly set by a PDF text-position operator, or derived from the previous run's displacement.
TextNumberAlignHow the number text aligns within the hanging-indent slot (w:lvlJc).
TextNumberFormatThe number format (ST_TextAutonumberScheme's base formats / ST_NumberFormat) — what a counter value renders as. Formats without a dedicated rendering (the CJK counting schemes) fall back to decimal, as the old engine renders them.
TextNumberingA paragraph's bullet/numbering (a:pPr's bullet choice group, or docx's w:numPr). None on the paragraph property means unspecified (inherit); this type's None variant is the explicit a:buNone suppression.
TextNumberingInstanceIdA numbering instance's id (w:num@numId) — the concrete list a paragraph counts in, which the numbering part maps to an abstract definition and its per-instance overrides.
TextNumberingSuffixWhat follows the number text (docx w:suff; pptx always tabs).
TextOleDrawAspectWhat an OLE object's presentation shows (@drawAspect, ST_ObjectDrawAspect).
TextOleUpdateModeWhen a linked OLE object refreshes (@updateMode, ST_ObjectUpdateMode).
TextParagraphAlignHorizontal alignment of a paragraph (a:pPr@algn / w:jc).
TextParagraphEndHow a paragraph ends: with its mark, or not at all.
TextParagraphProperties-
TextParagraphPropertyOne specified paragraph property — a [TextParagraphPropertyKey] carrying its value. The value-bearing twin of the key: set takes one, iter yields them, and the Loro mark builder maps each to a (key, value).
TextParagraphPropertyKeyA [TextParagraphProperties] property, named without its value — the sort / lookup / clear identity, the [TextParagraphProperty::key] projection, and the key the ClearParagraphProperties operation and the Loro marks carry. One variant per property, in the property order the sparse set sorts by.
TextParagraphSpacingThe gap above or below a paragraph (a:spcBef / a:spcAft / w:spacing@before / @after).
TextParagraphStyleIdA paragraph style's id (w:pStyle@val) — the key into the document's style table.
TextRenderingModePDF text rendering mode for paint output.
TextRunOne item of a text block: a show op, a marked-content sequence around none or several items, or a marked-content point.
TextSelectionWhat is selected within one text story — the characters of the story itself, or what is picked inside a block embedded in it.
TextSimpleFieldKindWhat a TextSimpleField is — a payload-free tag, and the dispatch key its evaluation reads.
TextSpanOne span in a TextParagraph — the text leaf, a special inline, or a container of nested spans.
TextStoryId-
TextStoryOffset-
TextTabAlignHow text aligns at a tab stop (ST_TextTabAlignType / ST_TabJc).
TextTabLeaderThe leader character filling the gap a tab jumps over (ST_TabTlc).
TextUnderlineStyleThe underline pattern (ST_TextUnderlineType / ST_Underline).
TextVerticalOverflowWhat text past its box's bottom does (ST_TextVertOverflowType).
TextWarpPresetTypeA built-in text warp (ST_TextShapeType, the @prst of a:prstTxWarp).
TextWrapWhether body text wraps at the frame width (ST_TextWrappingType).
ThemeFontRefA reference into the theme's ThemeFontScheme — its major (heading) or minor (body) collection. The script (latin / east-asian / complex) whose face it takes sits beside it on [TextFont::Theme].
VisibilityExpressionPDF OCMD /VE visibility expression (Section 8.11.2.4).
VisibilityPolicyPDF OCMD visibility policy (/P entry).
WindingRule-
WordprocessingCommandAn edit intent for a wordprocessing document. The editor turns a command into a CRDT modification; it never touches the model directly.
WordprocessingSearchScopeThe part of a word-processing document a search covers — the wordprocessing [SearchScope].
WordprocessingSelectionThe selection of a wordprocessing document's editor — presence state beside the CRDT, never in it (see [Selection]).