Skip to content

IParatextWindowPlugin

FoolRunning edited this page Jun 10, 2021 · 9 revisions

Properties

PluginMenuEntries

IEnumerable<WindowPluginMenuEntry> PluginMenuEntries


Name

string Paratext.PluginInterfaces.ParatextInternal.IParatextPlugin.Name

Gets the name of the plugin.


Version

Version Paratext.PluginInterfaces.ParatextInternal.IParatextPlugin.Version


VersionString

string Paratext.PluginInterfaces.ParatextInternal.IParatextPlugin.VersionString


Publisher

string Paratext.PluginInterfaces.ParatextInternal.IParatextPlugin.Publisher

Gets the name of the plugin's publisher.


MergeDataInfo

IEnumerable<KeyValuePair<string, XMLDataMergeInfo> > Paratext.PluginInterfaces.ParatextInternal.IParatextPlugin.MergeDataInfo

Defines the merge handling for all plugin data. The string is the name of the data identifier used when saving and the merge info defines the merge handling for that data. For any plugin data that is not XML or for which you want the default merge behavior, the merge info can be null. (see XMLDataMergeInfo for more information).

NOTE: If the plugin has no data to be saved in a project, null should be returned.


Methods

GetDescription

string Paratext.PluginInterfaces.ParatextInternal.IParatextPlugin.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).

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

Clone this wiki locally