-
Notifications
You must be signed in to change notification settings - Fork 4
IVersification
A system representing how chapter and verse numbers are assigned to the content of a Scripture book.
NOTE: Plugins typically will not need to implement own version of IVersification and are generally discouraged from doing so. If they do, and a customized versification is passed as the argument to this method, Paratext will return a new object having this versification, but the mapping might not be performed reliably.
bool IsCustomized
Gets whether this versification is customized in any way that diverges from the standard system.
NOTE: If the Type is StandardScrVersType.Unknown a versification is implicitly considered to be customized.
StandardScrVersType Type
The standard system used as the basis of this versification. IsCustomized
Gets a new IVerseRef object representing the given verse reference mapped into this versification. IVerseRef.ChangeVersification
NOTE: In the (unusual) case where a verse reference represents multiple verses and these verses are not all in the same chapter when mapped to this versification, the object returned will be undefined. To be safe, check IVerseRef.RepresentsMultipleVerses and call this method individually for each reference returned by IVerseRef.AllVerses.
IVerseRef CreateReference(int bookNum, int chapterNum, int verseNum)
Creates a new IVerseRef using this versification.
| Parameter | Description |
|---|---|
| return value | The requested verse reference or null if a verse or chapter number is out of range. |
| bookNum | The one-based book number based on the "standard" canonical order. |
| chapterNum | The one-based chapter number. |
| verseNum | The verse number. |
IVerseRef CreateReference(string refStr)
Creates a new IVerseRef from the specified standard reference format string.
| Parameter | Description |
|---|---|
| return value | The requested verse reference or null if it failed to parse or a verse or chapter number is out of range. |
| refStr | The reference format string in the standard reference format (bookCode chapter:verse). Bookcode is the standard 3-letter book code. Verse can contain commas (to represent a list of verses), dashes (to represent a range of verses), and/or letters (to represent partial verses). |
int GetLastChapter(int bookNum)
Gets the last chapter for the specified book
int GetLastVerse(int book, int chapter)
Gets the last verse for the specified book and chapter
bool IsExcluded(int bbbcccvvv)
Gets whether the specified verse is excluded in the versification.
| Parameter | Description |
|---|---|
| bbbcccvvv | An integer representing a verse reference, with 3 digits for the book, 3 digits for the chapter, and 3 digits for the verse. |
This page is auto-generated. User edits will be lost when regenerated.