-
Notifications
You must be signed in to change notification settings - Fork 6
IReferenceListItem
Object representing a list item in the IReferenceListWindow
string Message
An optional (localized) message (error, etc.) associated with this item. If not null this is what will be displayed in the list window; otherwise, the IScriptureTextSelection.SelectedText will be displayed.
string MessageId
An optional (NOT localized) unique ID associated with this item's message. If not null this is what will be used to store information about denied items; otherwise, the message itself will be used (which is less than ideal if messages are ever localized).
NOTE: If the Message is not null and the Severity is not SeverityLevel.Information and the list allows for items to be denied, it is strongly recommended that this property not return null.
To ensure that the message IDs are unique (cannot be confused with Paratext built-in or other plugin message IDs), the class implementing this interface should also implement the IPluginObject interface.
SeverityLevel Severity
An indicator of the severity of the item.
IVerseRef VerseRefStart
The verse where the selection starts.
IVerseRef VerseRefEnd
The verse where the selection ends.
string SelectedText
The selected text represented by this object. Can be an empty string (representing an insertion point).
int Offset
The character offset (in the raw USFM data) starting from the point before the \v (i.e., the slash is the 0th character).
string BeforeContext
The raw USFM text preceding the SelectedText (typically the entirety of the verse represented by VerseRefStart up to Offset).
string AfterContext
The raw USFM text following the SelectedText (typically the remainder of the verse represented by VerseRefEnd).
This page is auto-generated. User edits will be lost when regenerated.