IUSFMTextToken

Description

A token representing textual data. When occurring in a sequence of tokens, this text can be understood to pertain to the current paragraph (if any) and any open character style as indicated by the preceding opening - and not subsequently closed - marker(s).

NOTE: IUSFMMarkerToken

Properties

IsFigure

bool IsFigure

True if the token is part of a figure.

---

IsFootnoteOrCrossReference

bool IsFootnoteOrCrossReference

True if the token is part of a footnote or cross reference

---

IsMetadata

bool IsMetadata

Determines if the token is metadata (as opposed to publishable material)

---

IsPublishableVernacular

bool IsPublishableVernacular

Determines if the token is in publishable (not metadata) vernacular material

---

IsScripture

bool IsScripture

Determines if the token is in Scripture (includes chapter/verse numbers)

---

IsSpecial

bool IsSpecial

True if the token is part of a special indivisible group of tokens (link, category, or chapter/verse alternate/publishable)

---

Text

string Text

Text of the token.

---

VerseOffset

int VerseOffset

Character offset of the start of token in verse. This is defined as the offset from the backslash in the most recent \c, or \v defining the current "verse" (\c represents verse zero). For book introduction material, this is the start of the backslash in the \id.

NOTE: Chapter one does not reset the verse offset as it is considered introduction material.

---

VerseRef

IVerseRef VerseRef

Current verse reference

---

This page is auto-generated. User edits will be lost when regenerated.