-
Notifications
You must be signed in to change notification settings - Fork 6
IPluginChildWindow
Represents the window owning an embedded control. Paratext creates one of these at the request of a plugin when IWindowPluginHost.ShowEmbeddedUi is called.
bool AllowUserToChangeProject
Set to false to keep the user from changing the project set on this window. (Default is true.)
Icon Icon
Icon displayed in the titlebar of the hosting window.
IParatextChildState CurrentState
Gets the current state of the window.
void SetReference(IVerseRef newReference)
A plugin should call this to notify its parent window if its notion of the current reference changes.
void SetTitle(string title, bool appendReference=true, bool appendProject=true)
Sets the title of the window. It is generally advisable to keep this short. An EmbeddedPluginControl should generally set this in EmbeddedPluginControl.OnAddedToParent.
| Parameter | Description |
|---|---|
| title | The title |
| appendReference | True to append the reference to the title in a standard way; false to omit it. |
| appendProject | True to append the project to the title in a standard way; false to omit it. |
This page is auto-generated. User edits may be lost when updated.