Skip to content

Generate List Window Content

katherinejensen00 edited this page Jul 2, 2021 · 4 revisions

Paratext has a List Window, which contains a list of Scripture references and a message and severity level for each reference. A plugin can:

  • Generate content for the List Window
  • Read the current content of the List Window
  • Respond to user actions on the items in the List Window

The plugin accesses the List Window through the IReferenceListWindow member of the host. The plugin can register handlers for a set of events supported by the IReferenceListWindow interface.

The plugin can optionally provide a rerun method to Paratext. If provided, Paratext will add a rerun button to the List Window. When clicked, Paratext will call the rerun method which the plugin can use to recreate the content. The rerun method receives an IProgressInfo that the plugin can use to indicate progress if the rerun method is anticipated to take a long time to execute.

The items in the list implement the IReferenceListItem interface.

Clone this wiki locally