Skip to content

PluginAnnotationMenuEntry

FoolRunning edited this page Jul 26, 2022 · 9 revisions

Description

Represents a menu item that is to be inserted into an existing Paratext child window.

Events

LocalizedTextNeeded

LocalizeTextHandler LocalizedTextNeeded

Fired when localized text is needed in a specific locale


Properties

GetSource

Func<IProject, IPluginAnnotationSource> GetSource

The function to invoke to get the annotation source for a particular project.


ImagePath

string ImagePath

The file path to an image to show for the menu. Path can be relative to the plugin folder.


Methods

GetText

string GetText(string locale)

Gets the (localized) text of the menu item.

Parameter Description
locale ISO 639-3 language code with optional RFC 5646 subtags to identify the language in which term check name is requested. If a plugin is not localized or does not have a name in the requested locale, it falls back to the defaultText specified in the constructor.

PluginAnnotationMenuEntry

PluginAnnotationMenuEntry(string defaultText, Func< IProject, IPluginAnnotationSource > getSource, string imagePath=null)

Parameter Description
defaultText
getSource The function to invoke to get the annotation source for a particular project.
imagePath The file path to an image to show for the menu. Path can be relative to the plugin folder.

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

Clone this wiki locally