-
Notifications
You must be signed in to change notification settings - Fork 4
IReferenceListWindow
Object representing the (one and only) list of references.
ItemDoubleClickedHandler ItemDoubleClicked
Raised when an item is double-clicked.
NOTE: DisplayedListItems
Action ListChanged
Raised when the list changes.
NOTE: DisplayedListItems
Action SelectedItemChanged
Raised when the selected item(s) changes.
NOTE: DisplayedListItems
IReadOnlyList<IReferenceListItem> AllListItems
Gets the list of all items in the list window (unfiltered, sorted by reference). If the list window is not open, this returns null.
IReadOnlyList<IReferenceListItem> DisplayedListItems
Gets the list of items currently displayed in the list window (as sorted and filtered). If the list window is not open, this returns null.
IProject Project
The project associated with the current list of items, if any. If the list window is not open, this returns null.
IReadOnlyList<IReferenceListItem> SelectedItems
Gets all of the currently selected items
bool IsItemDenied(IReferenceListItem item)
Returns whether the specified item (i.e. error or warning) has been denied by the user.
void Load(IProject project, string description, IReadOnlyList< IReferenceListItem > items, bool allowDeny=false, Action< IProgressInfo > rerun=null)
Shows the list window (only one for all of Paratext) if not already shown and populates it with the given list of items.
NOTE: If the rerun action is invoked and the user subsequently cancels it, the plugin should note that and terminate the work of identifying new list items, but it may still call Load to reload the list with whatever items have been found thus far.
| Parameter | Description |
|---|---|
| project | The project associated with the items . Can be null for a list of items merely representing Scripture references. |
| description | The (localized) description to display at the head of the list (following the project name, if any) |
| items | The list of items. Can be an empty list. Paratext will sort this list according to the current sort-order setting. |
| allowDeny | A flag indicating whether the user should be allowed to "deny" items in the list (typically true for checking results). |
| rerun | An optional callback action invoked when the user clicks the Rerun button in the list header. Typically the plugin should re-generate the list based on the current data and call this method again with the updated list. |
| Exception | Condition |
|---|---|
| ArgumentNullException | items is null |
This page is auto-generated. User edits will be lost when regenerated.