IParatextWindowPlugin

Description

Interface for plugins that run when a menu item is clicked and want to create an embedded Paratext child window when clicked.

string Name

Gets the name of the plugin.

IEnumerable<WindowPluginMenuEntry> PluginMenuEntries

List fo menu items to create for this plugin

string Publisher

Gets the name of the plugin's publisher.

Version Version

The version of the plugin

string VersionString

The version of the plugin suitable for showing to the user

string GetDescription(string locale)

Gets the description of the plugin

Parameter	Description
locale	ISO 639-3 language code with optional RFC 5646 subtags to identify the language in which term plugin description is requested. If a plugin is not localized or does not have a description in the requested locale, it can fall back to English (en).

IDataFileMerger GetMerger(IPluginHost host, string dataIdentifier)

Gets an object that can be used to merge the data identified.

NOTE: For a standard XML-based merger that uses XMLDataMergeInfo, use IPluginHost.GetXmlMerger.

Parameter	Description
host	The plugin host
dataIdentifier	string identifying the data (e.g. a filename)

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