Run

Defined in: src/core/document-model/types.ts:268

ECMA-376 Part 1 §17.3.2 — a run: a span of text (or an inline image / math object) sharing one set of RunProperties, plus the reference markers (hyperlink, note, comment, page-number field) the layout acts on.

Properties

anchor?

readonly optional anchor?: string

Defined in: src/core/document-model/types.ts:292

§17.16.22 w:hyperlink @w:anchor — internal link target: a bookmark name in this document (never a URL — bypasses the scheme allowlist).

---

commentRangeRefs?

readonly optional commentRangeRefs?: readonly string[]

Defined in: src/core/document-model/types.ts:305

§17.13.4.3/4 w:commentRangeStart/End — the ids of the comment ranges this run falls inside (a run may be covered by several). Renderers highlight the covered span; the marker run (commentRef) sits at the range’s end.

---

commentRef?

readonly optional commentRef?: string

Defined in: src/core/document-model/types.ts:299

§17.13.4.1 w:commentReference — the run anchors a review comment by id; the comment’s content/author live in FlowDoc.comments.

---

endnoteRef?

readonly optional endnoteRef?: string

Defined in: src/core/document-model/types.ts:294

---

field?

readonly optional field?: "PAGE" | "NUMPAGES"

Defined in: src/core/document-model/types.ts:284

§17.16.5.35 PAGE / §17.16.5.33 NUMPAGES — the run is a page-number field; text holds the source’s cached result. Header/footer rendering substitutes the real number per page; body rendering keeps the cache.

---

footnoteRef?

readonly optional footnoteRef?: string

Defined in: src/core/document-model/types.ts:293

---

href?

readonly optional href?: string

Defined in: src/core/document-model/types.ts:278

ECMA-376 §17.16.22 — the run sits inside a w:hyperlink whose r:id resolved to an external target. The URL is stored as written in the rels part; writers MUST pass it through the scheme allowlist (core/links) before emitting anything clickable.

---

inlineImage?

readonly optional inlineImage?: InlineImage

Defined in: src/core/document-model/types.ts:317

When set, the run renders this image inline in the line; text is ignored.

---

listMarker?

readonly optional listMarker?: true

Defined in: src/core/document-model/types.ts:315

The run is a list-item marker materialized by applyNumbering ("1.", "•"). Tagged PDF wraps its glyphs in a Lbl structure element (§14.8.4.3.3).

---

math?

readonly optional math?: MathNode

Defined in: src/core/document-model/types.ts:319

When set, the run is an inline OfficeMath object; text is ignored.

---

native?

readonly optional native?: NativeBag

Defined in: src/core/document-model/types.ts:269

---

noteNumber?

readonly optional noteNumber?: true

Defined in: src/core/document-model/types.ts:310

§17.11.13 w:footnoteRef / §17.11.5 w:endnoteRef — inside note content: render the OWNING note’s number here.

---

pageBreak?

readonly optional pageBreak?: boolean

Defined in: src/core/document-model/types.ts:324

ECMA-376 Part 1 §17.3.3.1 — w:br w:type="page". A forced page break: the paragraph’s following content starts on a new page.

---

properties

readonly properties: RunProperties

Defined in: src/core/document-model/types.ts:271

---

text

readonly text: string

Defined in: src/core/document-model/types.ts:270