Skip to content

IBiblicalTermsWindow

Katherine Jensen edited this page Jul 2, 2021 · 9 revisions

Description

Object representing the (one and only) Biblical Terms tool window.

Events

SelectedItemChanged

Action SelectedItemChanged

Raised when the selected item(s) changes.

NOTE: SelectedItems


Properties

SelectedItems

IReadOnlyList<IBiblicalTerm> SelectedItems

Gets all of the currently selected items


Project

IProject Project

The primary project associated with the renderings for the current list of items, if any. If the Biblical Terms window is not open, this returns null.


Methods

Load

Task Load(IProject project, IBiblicalTerm termToSelect=null, IBiblicalTermList listToShow=null)

Shows the Biblical Terms window (only one for all of Paratext) if not already shown and populates it with the list of terms associated with the given project or the specified list.

Parameter Description
project The project whose renderings will be shown (if listToShow is null, the list of terms associated with this project will be shown).
termToSelect Optional term to select after loading.
listToShow Optional list of terms to show. See IPluginHost.GetBiblicalTermList and IProject.BiblicalTermList

LoadFilteredList

Task LoadFilteredList(IProject project, IReadOnlyList< IBiblicalTerm > termsToInclude, IBiblicalTermList listToShow=null)

Shows the Biblical Terms window (only one for all of Paratext) if not already shown and populates it with the list of terms associated with the given project or the specified list. The list will be filtered to display only the specified terms.

Parameter Description
project The project whose renderings will be shown (if listToShow is null, the list of terms associated with this project will be shown).
termsToInclude List of terms to include in the filtered display.
listToShow Optional list of terms to show. See IPluginHost.GetBiblicalTermList and IProject.BiblicalTermList

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

Clone this wiki locally