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
| Interface | Description |
|---|---|
| Accessibility | The 14.9 entries of a property list, which may be combined with others. |
| AcroFormCheckBoxField | A check box (§12.7.4.2.3): a button field with neither the Radio nor the Pushbutton flag. |
| AcroFormChoiceOption | One item of a choice field's /Opt. |
| AcroFormComboBoxField | A combo box (§12.7.4.4): a choice field with the Combo flag. |
| AcroFormFieldAdditionalActions | A field's /AA (Table 196). |
| AcroFormFieldFill | One field to fill in: the field id names, and what it is filled with. |
| AcroFormFieldShared | What every field type holds. |
| AcroFormListBoxField | A list box (§12.7.4.4): a choice field without the Combo flag. |
| AcroFormPushButtonField | A 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. |
| AcroFormRadioButtonField | A set of radio buttons (§12.7.4.2.4): a button field with the Radio flag, a button to each widget. |
| AcroFormSignatureField | A signature field (§12.7.4.5) — held unsigned: its /V, /Lock and /SV aren't. |
| AcroFormTextField | A 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. |
| AnnotationAppearanceState | One 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. |
| AnnotationMarkup | The entries a markup annotation carries (Table 170). |
| AnnotationRectDifferences | /RD — how far a drawn rectangle sits inside the annotation's rect, per side. |
| Artifact | An /Artifact sequence's property list (14.8.2.2.2, Table 363). |
| CaretAnnotation | A caret annotation (Table 180). |
| CircleAnnotation | A circle annotation (Table 177). |
| Color | A concrete color in the portable (editing-side) model: components interpreted in a [ColorSpaceRef]. |
| ContentControl | A content control's own properties (w:sdtPr + w:sdtEndPr) — what the control is, minus what it wraps. |
| ContentControlBinding | w:dataBinding — the custom-XML node a control mirrors. |
| ContentControlCheckBox | w14:checkbox — the state, and the two glyphs it paints. |
| ContentControlDate | w:date — how a date control formats, and which date it holds. |
| ContentControlDocPart | w:docPartObj / w:docPartList — which building blocks a control offers. |
| ContentControlList | w:comboBox / w:dropDownList — the choices, and the one taken. |
| ContentControlListItem | One w:listItem: what the user sees, and what the document stores. |
| ContentControlRepeatingSection | w15:repeatingSection — a region the user can repeat. |
| ContentControlSymbol | One w14:checkedState / w14:uncheckedState — a glyph in a named face. |
| CustomXml | What a custom XML element is (w:customXml's uri / element plus w:customXmlPr), minus what it wraps. |
| DefaultAppearance | A 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. |
| Diagram | A diagram: the parts a graphic frame names by id — what ShapeGraphicData::Diagram holds. |
| FileAttachmentAnnotation | A file attachment annotation (Table 184). |
| FixedPrint | /FixedPrint (Table 191). |
| Form | A self-contained, editable graphics-object body shared by every GraphicsObject whose content is a FormObject pointing at this definition. |
| FormObject | A reference to a Form — a PDF Do invocation site. |
| FreeTextAnnotation | A free text annotation (Table 174). |
| GraphicsObject | A single addressable item in the document's editing model. |
| GridCellRef | A 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. |
| GroupObject | A lightweight scene-tree wrapper — a marked-content sequence around its children, and a clip / soft-mask scope they share, with its own coordinate space. |
| ImageObject | An 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. |
| InkAnnotation | An ink annotation (Table 182). |
| LineAnnotation | A line annotation (Table 175). |
| LineStyle | Stroke line geometry — the brush-independent parameters that shape the outline of a stroked path. |
| LinkAnnotation | A link annotation (Table 173). |
| MovieAnnotation | A movie annotation (Table 186). The movie itself is not held. |
| NonstrokingStyle | Non-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). |
| OptionalContentMembership | PDF Optional Content Membership Dictionary (Section 8.11.2.2). |
| PaintBevel | A bevel (a:bevelT / a:bevelB, CT_Bevel): a preset profile at a given width/height. |
| PaintBlip | An image reference with its preprocessing effects (a:blip, CT_Blip). |
| PaintBlipFill | An image fill (a:blipFill, CT_BlipFillProperties). |
| PaintBlurEffect | a:blur (CT_BlurEffect) — a Gaussian blur of the whole shape. |
| PaintBorder | One edge's border (CT_Border) — its line style, width, color, and the gap to the content it encloses. |
| PaintCamera | The viewpoint (a:camera, CT_Camera). |
| PaintColor | - |
| PaintDashStop | One dash stop (a:ds, CT_DashStop): dash length then gap, each a fraction of the line width (1.0 = 100%). |
| PaintEffectList | A bag of named effects (a:effectLst, CT_EffectList), each optional, in the fixed DrawingML child order. |
| PaintFillOverlayEffect | a:fillOverlay (CT_FillOverlayEffect) — a second fill composited over the shape. |
| PaintGlowEffect | a:glow (CT_GlowEffect) — a colored halo around the shape. |
| PaintGradientFill | A gradient fill (a:gradFill, CT_GradientFillProperties). |
| PaintGradientStop | A gradient stop (a:gs, CT_GradientStop): a [PaintColor] at a position. |
| PaintInnerShadowEffect | a:innerShdw (CT_InnerShadowEffect) — a shadow cast inward from the edges. |
| PaintLightRig | The lighting (a:lightRig, CT_LightRig). |
| PaintLine | A line outline (a:ln, CT_LineProperties). Every field is optional so a partial override (just a width, just a dash) round-trips faithfully. |
| PaintLineEnd | An arrowhead (a:headEnd / a:tailEnd, CT_LineEndProperties). |
| PaintOuterShadowEffect | a:outerShdw (CT_OuterShadowEffect) — a drop shadow behind the shape. |
| PaintPatternFill | A pattern fill (a:pattFill, CT_PatternFillProperties): a [PaintPresetPattern] hatch drawn with a foreground over a background color. |
| PaintPresetShadowEffect | a:prstShdw (CT_PresetShadowEffect) — one of the 20 preset shadows. |
| PaintReflectionEffect | a:reflection (CT_ReflectionEffect) — a fading mirror image below the shape. |
| PaintRelativeRect | A relative rectangle (CT_RelativeRect): each edge an inset expressed as a fraction of the bounding box (1.0 = 100%). |
| PaintScene3d | The 3-D scene a shape sits in (a:scene3d, CT_Scene3D): a camera and a light rig (the optional a:backdrop is not modeled). |
| PaintShape3d | The 3-D shape properties (a:sp3d, CT_Shape3D): bevels, extrusion, contour, and material applied to a 2-D shape extruded into 3-D. |
| PaintSphericalRotation | A rotation in spherical coordinates (a:rot, CT_SphereCoords), all in degrees. |
| PaintSRgbColor | An sRGB color as a hex triplet — the @val of a:srgbClr, decomposed into bytes. |
| PaintTile | A tile (a:tile, CT_TileInfoProperties): offset, scale, flip, and anchor of the repeated image. |
| Path | - |
| PathClip | PDF W / W* clip — a filled region bounded by a path, evaluated under winding_rule. |
| PathObject | A path painted with an optional fill and/or stroke. |
| Point | - |
| PolygonAnnotation | A polygon annotation (Table 178). |
| PolyLineAnnotation | A polyline annotation (Table 178). |
| PopupAnnotation | A popup annotation (Table 183) — the window a markup annotation's text shows in. |
| PortableTextEndpoint | One 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.) |
| PresentationTextEndpoint | One 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.) |
| PrinterMarkAnnotation | A printer's mark annotation (§12.5.6.20). |
| Rect | - |
| RedactAnnotation | A redaction annotation (Table 192). |
| RenderStyle | Per-paint-op call-uniform compositing state. |
| RichTextStyle | What 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. |
| ScreenAnnotation | A screen annotation (Table 187). |
| ShadingObject | A gradient or mesh painted directly (PDF sh operator). |
| Shape | A 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. |
| ShapeAdjustPoint | An adjustable point (a:pos, CT_AdjPoint2D). |
| ShapeConnection | A connection endpoint (a:stCxn / a:endCxn, CT_Connection). |
| ShapeConnectionSite | A connection site (a:cxn, CT_ConnectionSite): a point a connector can attach to. |
| ShapeConnector | A connector (a:cxnSp, CT_Connector): a shape (typically a preset line geometry) whose ends optionally bind to other shapes' connection sites. |
| ShapeCustomGeometry | A custom geometry (a:custGeom, CT_CustomGeometry2D): a guide-driven path outline with its adjust handles, connection sites, and text rect. |
| ShapeExtents | A non-negative size in points (CT_PositiveSize2D, a:ext and friends; converted from EMU at import). |
| ShapeFontRef | A reference into the theme font scheme (a:fontRef, CT_FontReference). |
| ShapeFragment | A 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). |
| ShapeGeometryGuide | A geometry guide (a:gd, CT_GeomGuide): a named value computed by a formula, in both a:avLst and a:gdLst. |
| ShapeGeometryRect | A geometry rectangle in adjustable coordinates (a:rect, CT_GeomRect). |
| ShapeGraphicFrame | A graphic frame (a:graphicFrame, CT_GraphicalObjectFrame): positions a non-shape graphic — a table, chart, diagram, or OLE object — within the shape tree. |
| ShapeGraphicFrameLocks | What 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. |
| ShapeGroup | A group shape (a:grpSp, CT_GroupShape): nests child [ShapeNode]s under its own transform and child coordinate space. |
| ShapeGroupProperties | A 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. |
| ShapeMedia | The media an element plays (a:EG_Media in p:nvPr, and p14:media in its p:extLst). |
| ShapeMediaBookmark | A named point in a [ShapeMedia]'s file (p14:bmk). |
| ShapeNonVisualProperties | The 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). |
| ShapeOleObject | An 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. |
| ShapePath | One outline path (a:path, CT_Path2D). |
| ShapePicture | A picture (a:pic, CT_Picture): an image placed through a blip fill, shaped and positioned like any other shape. |
| ShapePlaceholder | - |
| ShapePoint | - |
| ShapePolarAdjustHandle | A polar adjust handle (a:ahPolar, CT_PolarAdjustHandle). |
| ShapePresetGeometry | A preset shape geometry (a:prstGeom, CT_PresetGeometry2D): a named [ShapePresetGeometryType] plus the adjust values that tune it. |
| ShapeProperties | A shape's visual properties (a:spPr, CT_ShapeProperties): its a:xfrm placement together with geometry, fill, line, and effects. |
| ShapeStyle | A shape's style references (a:style, CT_ShapeStyle): one reference into each of the theme's four style dimensions. |
| ShapeStyleMatrixRef | A reference into one style-matrix list (CT_StyleMatrixReference, e.g. a:fillRef). |
| ShapeTransform | A shape's transform (a:xfrm, CT_Transform2D): where it sits, how big it is, and its rotation/flip. |
| ShapeTree | The shape-tree root — the reusable model root every doc type embeds. |
| ShapeXyAdjustHandle | An XY adjust handle (a:ahXY, CT_XYAdjustHandle). |
| Size | - |
| SmartTag | What a smart tag is (w:smartTag's uri / element plus w:smartTagPr), minus the spans it wraps. |
| SoundAnnotation | A sound annotation (Table 185). The sound itself is not held. |
| SquareAnnotation | A square annotation (Table 177). |
| StampAnnotation | A rubber stamp annotation (Table 181). |
| StrokingStyle | Stroking 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). |
| StructureContent | A marked-content sequence that is a content item of a structure element (14.7.5.2). |
| Table | A table (a:tbl / w:tbl): its grid, its rows, and the properties that govern them. |
| TableBackgroundStyle | The backdrop a pptx table style paints beneath everything (a:tblBg, CT_TableBackgroundStyle) — one themeable fill and one themeable effect, each optional. |
| TableBorder | One edge's stroke, as both dialects spell it. |
| TableBorders | A table's own edge set (w:tblBorders) — the outside four plus the two interiors that separate its cells. |
| TableCell3D | A cell's 3-D treatment (a:cell3D) — a bevel on its top face, an optional light rig, and the material its surface imitates. |
| TableCellBorders | A cell's edge set — its four sides, its two diagonals, and the interiors a merged region draws inside itself. |
| TableCellBorderStyle | a:tcBdr (CT_TableCellBorderStyle) — a pptx style region's eight edges, each themeable. |
| TableCellMargins | The padding between a cell's edges and its content, in points. |
| TableCellProperties | A cell's own properties (a:tcPr / w:tcPr) — the superset union. |
| TableCellRef | Where 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. |
| TableCellStyle | a:tcStyle (CT_TableStyleCellStyle) — what one region of a pptx table style says about a cell. |
| TableColumn | One grid column (a:gridCol / w:gridCol): its identity and its declared width in points. |
| TableConditional | The 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. |
| TableControlCell | A cell-level content control (docx w:sdt, CT_SdtCell) — a container wrapping consecutive cells within one row. |
| TableControlRow | A row-level content control (docx w:sdt, CT_SdtRow) — a container wrapping consecutive rows, with the control's own metadata. |
| TableCustomXmlCell | A cell-level custom XML element (docx w:customXml, CT_CustomXmlCell) — a container wrapping consecutive cells. |
| TableCustomXmlRow | A row-level custom XML element (docx w:customXml, CT_CustomXmlRow) — a container wrapping consecutive rows, with the element's own name and attributes. |
| TableFloating | A 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. |
| TableFragment | A rectangular block of cells lifted from one table — the fragment twin of a TableSelection's cell block, and the table arm of CommonFragment. |
| TableLook | Which conditional regions of a table's style apply (a:tblPr's six flags / w:tblLook). |
| TablePartStyle | What one region of a table style says. |
| TablePartStyles | One [TablePartStyle] per [TablePart], named as the schema names them. |
| TableProperties | A table's own properties — the a:tblPr / w:tblPr union. |
| TableRegularCell | One cell of the dense grid: its merge state on each axis, its properties, and its [TextBody]. |
| TableRegularRow | One row (a:tr / w:tr): its identity, its properties, and its cells. |
| TableRowProperties | A row's properties — a:tr@h and the whole of w:trPr. |
| TableStyle | One named table style. |
| TextActiveXControl | An ActiveX control embedded in a span (w:control, CT_Control). |
| TextAnnotation | A text (sticky note) annotation (Table 172). |
| TextBody | The rich-text body a shape or table cell holds (a:txBody, CT_TextBody): body-level properties and the [TextStory] of paragraphs. |
| TextBodyProperties | Body-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. |
| TextBookmarkEnd | A bookmark's closing mark (w:bookmarkEnd, CT_MarkupRange) — one unit, naming the bookmark it closes by id. |
| TextBookmarkStart | A bookmark's opening mark (w:bookmarkStart, CT_Bookmark) — one unit, carrying the name. |
| TextBreak | a:br / w:br — an explicit break within the paragraph. One unit. |
| TextClip | Glyph-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. |
| TextComplexField | A field spelled with a field code: w:fldChar+w:instrText, or w:fldSimple. |
| TextComplexFieldEnd | A complex field's closing mark — one unit, closing the innermost open field. |
| TextComplexFieldStart | A complex field's opening mark — one unit, carrying the definition. |
| TextControlBlock | A block-level structured document tag / content control (docx w:sdt, CT_SdtBlock) — a container of nested blocks, contributing no characters of its own. |
| TextControlSpan | A 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. |
| TextCustomXmlBlock | A block-level custom XML element (docx w:customXml, CT_CustomXmlBlock) — a container of nested blocks, contributing no characters of its own. |
| TextCustomXmlSpan | A span-level custom XML element (docx w:customXml, CT_CustomXmlRun) — the same construct as TextCustomXmlBlock at the level below, wrapping spans rather than blocks. |
| TextDrawing | A 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. |
| TextDrawingEffectExtent | How far a drawing's effects reach past its extent (wp:effectExtent, CT_EffectExtent), in points on each edge. |
| TextDrawingWrapDistance | How far text keeps clear of a drawing on each edge (distT / distB / distL / distR, ST_WrapDistance), in points. |
| TextEastAsianLayout | East Asian layout (w:eastAsianLayout / @kumimoji) — the character-fitting features for CJK text. |
| TextEmbeddedObject | An 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. |
| TextFloatingHorizontalPosition | wp:positionH — where a floating drawing sits across the page: what the position is measured from, and where within that it lands. |
| TextFloatingPlacement | Everything 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. |
| TextFloatingVerticalPosition | wp:positionV — where a floating drawing sits down the page, the vertical twin of [TextFloatingHorizontalPosition]. |
| TextFloatingWrapPolygon | The contour a tight or through wrap follows (wp:wrapPolygon, CT_WrapPath). |
| TextFormField | w:ffData — a form field's state: what it is called, how it behaves, and what the user has put in it. |
| TextFragment | A sequence of story content to splice in — an ordered list of blocks whose boundary paragraphs fuse into the splice site. |
| TextGroupRun | A marked-content sequence begun and ended inside a text block around none or several runs — one /P <</MCID n>> per paragraph, say. |
| TextHyperlink | The 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. |
| TextLanguage | The span's language tags (w:lang / a:rPr@lang + @altLang) — BCP-47 tags such as "en-US" or "ja-JP", one per script slot. |
| TextLigatures | The 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. |
| TextListStyle | A per-level set of paragraph defaults (CT_TextListStyle) — nine [TextParagraphProperties], one per outline level, over a default layer that sits beneath them all. |
| TextMarkedContentPoint | A marked-content point (MP or DP) inside a text block. |
| TextMarkupAnnotation | A highlight, underline, squiggly-underline, or strikeout annotation (Table 179). |
| TextMath | An 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). |
| TextNumberingLevel | One numbering level definition — how the bullet/number for a paragraph renders. |
| TextObject | A text object: the items of one BT…ET block in stream order — show ops, the marked-content sequences around them, and marked-content points. |
| TextOleObject | An OLE object's binding (CT_ObjectEmbed, o:OLEObject). |
| TextParagraph | A paragraph (a:p, CT_TextParagraph): its paragraph-level properties, the character properties of its paragraph mark, and the spans that carry the content. |
| TextParagraphBorders | A paragraph's six border edges (w:pBdr, CT_PBdr), each the character side's [PaintBorder]. An absent edge draws nothing. |
| TextPosition | A position in a page's text: a codepoint offset into show op run of the text object object. |
| TextRegular | a:r (CT_RegularTextRun) — a styled run of text: the paragraph's text leaf. Its span is the text's codepoint length. |
| TextRegularRun | One text-showing operator — Tj, TJ, ' or " — of a TextObject, placed by its own text matrix. |
| TextSimpleField | A field spelled as one self-contained element: a:fld in DrawingML, w:pgNum and the date six in wordprocessing. |
| TextSmartTagSpan | A smart tag (docx w:smartTag, CT_SmartTagRun) — a container of spans, contributing no characters of its own. |
| TextStory | The 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. |
| TextStyle | PDF text-state operators grouped into one struct — Tf, Tc, Tw, Tz, TL, Tr, Ts, Tk. |
| TextTab | w:tab — an explicit tab. One unit. Wordprocessing-only; DrawingML uses a literal tab char in a Regular span instead. |
| TextTable | A 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. |
| TextTabStop | One tab stop (CT_TextTabStop / CT_TabStop): where a tab jumps, how the following text aligns there, and what fills the gap. |
| TextUnderline | An underline (u / a:uLn / a:uFill / w:u) — its style pattern plus the DrawingML-split stroke and fill. |
| TextWarp | A preset text warp (a:prstTxWarp, CT_PresetTextShape): a named [TextWarpPresetType] plus the adjust values that tune it — the text counterpart of ShapePresetGeometry. |
| ThreeDAnnotation | A 3D annotation (Table 298). The 3D stream and views are not held. |
| TransparencyGroup | PDF transparency-group attributes carried on a Form XObject's /Group dictionary. |
| WatermarkAnnotation | A watermark annotation (Table 190). |
| WidgetAnnotation | A widget annotation (Table 188) — a form field's appearance on the page. The field it belongs to names it (AcroFormFieldShared::widgets). |
| WordprocessingTextEndpoint | One 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.) |
| XmlAttribute | One 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 Alias | Description |
|---|---|
| AcroFormField | A 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. |
| AcroFormFieldValue | What a field is filled with, by its type. A push-button has no value, and a signature field is signed, not filled in. |
| Action | What activating a link or widget does (§12.6.4), one variant per action type (Table 198). |
| ActionHideTarget | One of the annotations a Hide action shows or hides (Table 214). |
| AlignFrame | - |
| AnnotationAppearanceStreams | One entry of /AP: a single appearance, or a set of named states. |
| AnnotationBorderStyleKind | /BS /S. |
| AnnotationCaptionPosition | /CP on a line annotation. |
| AnnotationCommand | An 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. |
| AnnotationLineEnding | A 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. |
| ArtifactSubtype | A pagination artifact's /Subtype. |
| ArtifactType | An artifact's /Type. |
| BlendMode | Compositing blend mode. |
| Brush | The source of color used to fill or stroke a shape (PDF editing model). |
| CallError | Why a session refused a call. |
| CaretSymbol | /Sy — the symbol a caret annotation shows (Table 180). |
| ChartExSpaceId | - |
| ChartSpaceId | - |
| Clip | A clipping region. |
| ColorSpaceId | - |
| ColorSpaceRef | A reference to a color space — either a built-in device/sRGB space or a registered non-device space looked up via ColorSpaceId. |
| ContentControlAppearance | w15:appearance (ST_SdtAppearance) — the chrome a control draws. |
| ContentControlCalendar | w:calendar (ST_CalendarType) — the calendar a date is expressed in. |
| ContentControlDateStorage | w:storeMappedDataAs (ST_SdtDateMappingType) — the form a bound date takes in the custom XML part. |
| ContentControlKind | The type element in w:sdtPr, and the per-type state that rides with it. |
| ContentControlLock | w:lock (ST_Lock) — what a control protects. |
| ErrorKind | What 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. |
| FileAttachmentIcon | A file attachment annotation's icon (Table 184). |
| FontId | - |
| FooterId | - |
| GraphicsObjectContent | What a [GraphicsObject] paints. |
| GraphicsObjectId | - |
| GridCharWidth | A column width in OOXML character units — the count of maximum-digit-width characters that fit across the column, from <col @width> / <sheetFormatPr @defaultColWidth>. |
| GridColumnId | - |
| GridColumnWidth | A 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.) |
| GridRowHeight | An explicit row height in points. Absent (None on [GridRow::height]) means the sheet default applies. |
| GridRowId | - |
| HeaderId | - |
| ImageCommand | An edit intent for an image document. The editor turns a command into a CRDT modification; it never touches the model directly. |
| ImageId | - |
| ImageSearchScope | The part of an image a search covers — the image [SearchScope]. An image holds no text, so a search over it finds nothing. |
| ImageSelection | The (always empty) selection of an image document's editor. |
| LineCap | - |
| LineJoin | - |
| MarkedContent | The tag and property list of one marked-content sequence or point. |
| Markup | One wrapper of the markup family, whichever kind it is. |
| ObjectAlignEdge | The edge (or center line) an AlignObjects gesture pulls each object's bounding box to within the reference rectangle. |
| ObjectAlignTarget | The reference an AlignObjects aligns to. |
| ObjectAxis | The axis a FlipObjects / DistributeObjects gesture acts along. |
| ObjectCommand | An 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. |
| ObjectTextCommand | An edit intent on a page's text, its positions in the paragraphs the layout derives (DerivedTextBlock), which flow in their boxes (DerivedTextBox). |
| ObjectZOrder | A z-order gesture for ReorderObjects. Paint order is the sibling list's order (first painted first), so the last object is on top. |
| OptionalContent | A single optional-content scope: what an /OC sequence holds, or an image or form whose own /OC it is. |
| OptionalContentGroupId | - |
| OverprintMode | Overprint mode controlling how source colors interact with the backdrop during a paint operation marked overprint-enabled. |
| PageEdge | A page edge an artifact is attached to. |
| PageId | - |
| PaintBevelType | Bevel profile (ST_BevelPresetType, the @prst of a:bevelT / a:bevelB). |
| PaintBlendMode | Compositing mode for a fill overlay (ST_BlendMode, the @blend of a:fillOverlay). |
| PaintBlipEffect | An image transform on a [PaintBlip] — one of CT_Blip's effect children. |
| PaintBlipFillMode | Tile vs. stretch for a [PaintBlipFill] — the a:tile / a:stretch choice. |
| PaintBlipSource | Where a blip's image comes from — the a:blip relationship attributes. |
| PaintBorderStyle | The line pattern of a [PaintBorder] (ST_Border). |
| PaintCameraPreset | Preset camera position/projection (ST_PresetCameraType, the @prst of a:camera). |
| PaintColorBase | The base of a [PaintColor] — one of the six DrawingML color choices (the EG_ColorChoice member elements), or SpreadsheetML's indexed one. |
| PaintColorTransform | A single color transform — one child element of the EG_ColorTransform group. |
| PaintCompoundLine | Compound (multi-stroke) line type (ST_CompoundLine, the @cmpd of a:ln). |
| PaintFill | A fill: how a shape, line, text, or background is painted. |
| PaintGradientShade | Linear vs. path shading for a [PaintGradientFill] — the a:lin / a:path choice. |
| PaintLightDirection | Light-rig pointing direction (ST_LightRigDirection, the @dir of a:lightRig). |
| PaintLightRigType | Preset light arrangement (ST_LightRigType, the @rig of a:lightRig). |
| PaintLineCap | Line end-cap style (ST_LineCap, the @cap of a:ln). |
| PaintLineDash | A dash pattern — the EG_LineDashProperties choice. |
| PaintLineEndSize | Arrowhead size step (ST_LineEndWidth / ST_LineEndLength, the @w / @len of a line end). |
| PaintLineEndType | Arrowhead shape (ST_LineEndType, the @type of a line end). |
| PaintLineJoin | The corner join of a stroke — the EG_LineJoinProperties choice. |
| PaintPathShade | The radiation pattern of a path gradient (ST_PathShadeType, the @path of a:path). |
| PaintPenAlignment | Pen alignment relative to the path (ST_PenAlignment, the @algn of a:ln). |
| PaintPresetColor | A named preset color (ST_PresetColorVal, the @val of a:prstClr) — each a fixed sRGB value. |
| PaintPresetDash | A preset dash pattern (ST_PresetLineDashVal, the @val of a:prstDash). |
| PaintPresetMaterial | Surface material (ST_PresetMaterialType, the @prstMaterial of a:sp3d). |
| PaintPresetPattern | A preset hatch pattern (ST_PresetPatternVal, the @prst of a:pattFill). The token differs from the variant name, so each is annotated. |
| PaintRectAlign | A nine-point anchor (ST_RectAlignment) — first-tile origin for a tiled fill, and shadow/effect alignment. |
| PaintSchemeColor | A slot referenced by schemeClr (ST_SchemeColorVal) — the abstract names a styled object uses, resolved through the consumer's color map to a ThemeColorScheme slot. |
| PaintSystemColor | A system color slot (ST_SystemColorVal, the @val of a:sysClr) — the Win32 GetSysColor palette. Carried with a @lastClr fallback on [PaintColorBase::System]. |
| PaintTileFlip | How a tiled fill or gradient mirrors as it repeats (ST_TileFlipMode). |
| PathSegment | - |
| PatternId | - |
| PortableSearchScope | The pages a PDF search covers — the portable [SearchScope]. |
| PortableSelection | The selection of a portable document's editor — presence state beside the CRDT, never in it (see [Selection]). |
| PresentationSearchScope | The slides a presentation search covers — the presentation [SearchScope]. |
| PresentationSelection | The selection of a presentation document's editor — presence state beside the CRDT, never in it (see [Selection]). |
| PropertyList | A property list (14.6.2) as written, its entries in order. |
| PropertyValue | A value in a [PropertyList]. |
| RawId | Document entity id as a replica-counter hex key (e.g. "3a-1"). |
| RenderingIntent | Rendering intent — the ICC color reproduction strategy used when converting a paint's source color space into the destination. |
| RichTextFontStretch | font-stretch — how narrow or wide a face of its family the text is set in. |
| ScriptCategory | The font-slot category a character's script maps to — the three typeface slots office text selects between. |
| SectionId | - |
| ShapeAdjustAngle | An adjustable angle (ST_AdjAngle): either a literal in degrees or a reference to a guide by name. |
| ShapeAdjustCoordinate | An adjustable coordinate (ST_AdjCoordinate): either an EMU literal or a reference to a guide by name. |
| ShapeAdjustHandle | An adjust handle — the a:ahXY / a:ahPolar choice in a:ahLst. |
| ShapeAlignEdge | The edge (or center line) an AlignShapes gesture pulls each node's bounding box to within the reference rectangle. |
| ShapeAxis | The axis a FlipShapes / DistributeShapes gesture acts along. |
| ShapeFontCollectionIndex | Which theme font collection a [ShapeFontRef] selects (ST_FontCollectionIndex, the @idx of a:fontRef). |
| ShapeGeometry | A shape's outline — the a:prstGeom / a:custGeom choice. |
| ShapeGraphicData | What a frame hosts (a:graphicData), dispatched by its @uri. |
| ShapeMediaKind | The kind of a [ShapeMedia] — the a:EG_Media choice. |
| ShapeNode | An addressable shape-tree node — the EG_ShapeElement-style choice of what a shape tree holds, one variant per element kind. |
| ShapeNodeId | - |
| ShapeOleBinding | Where a [ShapeOleObject]'s data lives (p:embed / p:link). |
| ShapeOleColorScheme | What of the colour scheme an embedded OLE object's server is handed (@followColorScheme, ST_OleObjectFollowColorScheme). |
| ShapePathCommand | One path drawing command — a child element of a:path. |
| ShapePathFillMode | How a custom path is filled (ST_PathFillMode, the @fill of a:path). |
| ShapePlaceholderOrientation | The text-flow orientation of a [ShapePlaceholder] (ST_Direction). |
| ShapePlaceholderSize | The relative size hint of a [ShapePlaceholder] (ST_PlaceholderSize). |
| ShapePlaceholderType | The kind of a [ShapePlaceholder] (ST_PlaceholderType). |
| ShapePresetGeometryType | A built-in preset shape (ST_ShapeType, the @prst of a:prstGeom). |
| ShapeSelection | What is selected within one shape tree — object(s), or a caret / range inside one shape's text. |
| ShapeZOrder | A 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 | - |
| SoundIcon | A sound annotation's icon (Table 185). |
| SpreadsheetCommand | An edit intent for a spreadsheet document. The editor turns a command into a CRDT modification; it never touches the model directly. |
| SpreadsheetSearchScope | The sheets a workbook search covers — the spreadsheet [SearchScope]. |
| SpreadsheetSelection | The selection of a spreadsheet document's editor — presence state beside the CRDT, never in it (see [Selection]). |
| StampIcon | A rubber stamp annotation's icon (Table 181). |
| StandardFont | One of the 14 standard fonts (§9.6.2.2) — the font a host adds with AddStandardFont, and a font list entry's standard. |
| StartError | Why a session could not be started. |
| TableAlignment | How a table sits across the text column (w:jc). |
| TableCell | One cell of a TableRegularRow — what OOXML lets sit directly inside w:tr, where a cell may sit. |
| TableCellMerge | How a cell merges along one axis. |
| TableColumnId | - |
| TableCommand | An 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 | - |
| TableLayout | Whether the declared grid is authoritative (w:tblLayout). |
| TableOverlap | Whether a floating table may overlap another (w:tblOverlap). |
| TableRow | One row of a Table — what OOXML lets sit directly inside w:tbl, where a row may sit. |
| TableRowHeight | How tall a row is (a:tr@h, w:trHeight + @w:hRule), in points. |
| TableRowId | - |
| TableSelection | What 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. |
| TableStyleId | A table style's id — the key a table's style names. |
| TableStyleRef | How a table names its style. |
| TableThemeableEffect | EG_ThemeableEffectStyle — a literal a:effect, or an a:effectRef into the style matrix's a:effectStyleLst. |
| TableThemeableFill | EG_ThemeableFillStyle — a literal a:fill, or an a:fillRef into the style matrix's a:fillStyleLst. |
| TableThemeableLine | CT_ThemeableLineStyle — a literal a:ln, or an a:lnRef into the style matrix's a:lnStyleLst. |
| TableWidth | A declared width (CT_TblWidth), in points or as a fraction. |
| Text3d | How a body's text stands in 3-D — the EG_Text3D choice on a:bodyPr. |
| TextAnchor | Vertical anchoring of a body's content in its frame (ST_TextAnchoringType / w:vAlign). |
| TextAutoFit | The frame/text fit negotiation (a:noAutofit / a:normAutofit / a:spAutoFit). |
| TextBaselineAlign | Super/subscript vertical positioning (a:rPr@baseline / w:vertAlign) — distinct from the raw baseline_offset (w:position), which is a signed point shift. |
| TextBlock | One block in a TextStory. |
| TextBreakKind | Which flow a [TextBreak] advances (docx w:br@type). |
| TextCharacterProperties | - |
| TextCharacterProperty | One 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. |
| TextCharacterPropertyKey | A [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. |
| TextCharacterStyleId | A character style reference (w:rStyle) — the id of the named character style a span inherits from. |
| TextChunk | A piece of a show-text operation: either glyph bytes to paint or a horizontal adjustment. |
| TextCombineBrackets | The bracket style around combined East Asian characters (@combineBrackets / ST_CombineBrackets). |
| TextCommand | An 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. |
| TextComplexFieldKind | What a TextComplexField is — a payload-free tag, and the dispatch key a field pass evaluates on. |
| TextDatePart | One component of the current date — what a wordprocessing shortcut element paints. |
| TextDateTimeFormat | One of a:fld's date-time formats — a whole date, rendered as the type asked. |
| TextDirection | The direction text flows (w:textDirection@val, ST_TextDirection; and a:bodyPr@vert / a:tcPr@vert, ST_TextVerticalType). |
| TextDrawingCommand | An edit intent for one TextDrawing — the w:drawing at a slot in a story. |
| TextDrawingPlacement | How a drawing meets the text around it — w:drawing's own choice of wp:inline or wp:anchor. |
| TextEmbeddedObjectBinding | What a [TextEmbeddedObject]'s presentation stands in for. |
| TextEmphasisMark | The East Asian emphasis mark (ST_Em / w:em) — dots or circles set beside each glyph for emphasis. docx-only; DrawingML has no counterpart. |
| TextFloatingHorizontalAlignment | Where a floating drawing lands within its horizontal origin — the file's choice of wp:align or wp:posOffset, as one value. |
| TextFloatingHorizontalOrigin | What a horizontal position is measured from (wp:positionH/@relativeFrom, ST_RelFromH). |
| TextFloatingVerticalAlignment | Where a floating drawing lands within its vertical origin, the twin of [TextFloatingHorizontalAlignment]. |
| TextFloatingVerticalOrigin | What a vertical position is measured from (wp:positionV/@relativeFrom, ST_RelFromV). |
| TextFloatingWrap | What the text does around a floating drawing — the file's five wrap elements, which are a choice of exactly one. |
| TextFloatingWrapSide | Which sides of a floating drawing text runs down (@wrapText, ST_WrapText). |
| TextFont | A span's typeface reference — a concrete face name or a theme font slot. |
| TextFontAlign | Where 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. |
| TextFormFieldKind | The three form fields, each with the state only it has. |
| TextFormInputKind | w:textInput@type (ST_FFTextType) — what a text form field accepts. |
| TextHyperlinkAction | What 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. |
| TextHyperlinkShowJump | Where a [TextHyperlinkAction::ShowJump] moves — jump= of ppaction://hlinkshowjump. |
| TextHyperlinkTarget | A [TextHyperlink]'s destination. |
| TextIcon | A text annotation's icon (Table 172). |
| TextLineSpacing | A paragraph's line spacing rule (a:lnSpc / w:spacing@line + @lineRule) — the three Word models. Unspecified defaults to single spacing, Percent(1.0). |
| TextMatrixOrigin | How 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. |
| TextNumberAlign | How the number text aligns within the hanging-indent slot (w:lvlJc). |
| TextNumberFormat | The 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. |
| TextNumbering | A 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. |
| TextNumberingInstanceId | A 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. |
| TextNumberingSuffix | What follows the number text (docx w:suff; pptx always tabs). |
| TextOleDrawAspect | What an OLE object's presentation shows (@drawAspect, ST_ObjectDrawAspect). |
| TextOleUpdateMode | When a linked OLE object refreshes (@updateMode, ST_ObjectUpdateMode). |
| TextParagraphAlign | Horizontal alignment of a paragraph (a:pPr@algn / w:jc). |
| TextParagraphEnd | How a paragraph ends: with its mark, or not at all. |
| TextParagraphProperties | - |
| TextParagraphProperty | One 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). |
| TextParagraphPropertyKey | A [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. |
| TextParagraphSpacing | The gap above or below a paragraph (a:spcBef / a:spcAft / w:spacing@before / @after). |
| TextParagraphStyleId | A paragraph style's id (w:pStyle@val) — the key into the document's style table. |
| TextRenderingMode | PDF text rendering mode for paint output. |
| TextRun | One item of a text block: a show op, a marked-content sequence around none or several items, or a marked-content point. |
| TextSelection | What is selected within one text story — the characters of the story itself, or what is picked inside a block embedded in it. |
| TextSimpleFieldKind | What a TextSimpleField is — a payload-free tag, and the dispatch key its evaluation reads. |
| TextSpan | One span in a TextParagraph — the text leaf, a special inline, or a container of nested spans. |
| TextStoryId | - |
| TextStoryOffset | - |
| TextTabAlign | How text aligns at a tab stop (ST_TextTabAlignType / ST_TabJc). |
| TextTabLeader | The leader character filling the gap a tab jumps over (ST_TabTlc). |
| TextUnderlineStyle | The underline pattern (ST_TextUnderlineType / ST_Underline). |
| TextVerticalOverflow | What text past its box's bottom does (ST_TextVertOverflowType). |
| TextWarpPresetType | A built-in text warp (ST_TextShapeType, the @prst of a:prstTxWarp). |
| TextWrap | Whether body text wraps at the frame width (ST_TextWrappingType). |
| ThemeFontRef | A 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]. |
| VisibilityExpression | PDF OCMD /VE visibility expression (Section 8.11.2.4). |
| VisibilityPolicy | PDF OCMD visibility policy (/P entry). |
| WindingRule | - |
| WordprocessingCommand | An edit intent for a wordprocessing document. The editor turns a command into a CRDT modification; it never touches the model directly. |
| WordprocessingSearchScope | The part of a word-processing document a search covers — the wordprocessing [SearchScope]. |
| WordprocessingSelection | The selection of a wordprocessing document's editor — presence state beside the CRDT, never in it (see [Selection]). |