IPluginChildWindow

Description

Represents the window owning an embedded control. Paratext creates one of these at the request of a plugin when IWindowPluginHost.ShowEmbeddedUi is called.

Events

MegaMenuShowing

MegaMenuShowingHandler MegaMenuShowing

Raised when the mega menu for this window is about to be shown.

---

ProjectChanged

ProjectChangedHandler ProjectChanged

Raised when the user changes the project for this window. Unless AllowUserToChangeProject is false, the plugin should handle this event.

---

SaveRequested

SaveRequestedHandler SaveRequested

Raised when the user requests a save.

---

VerseRefChanged

ChildWindowReferenceChangedHandler VerseRefChanged

Raised when the Scripture reference is changed.

---

WindowClosing

ChildWindowClosingHandler WindowClosing

Raised when preparing to close.

---

Properties

AllowUserToChangeProject

bool AllowUserToChangeProject

Set to false to keep the user from changing the project set on this window. (Default is true.)

---

CurrentState

IParatextChildState CurrentState

Gets the current state of the window.

---

Icon

Icon Icon

Icon displayed in the titlebar of the hosting window.

---

Methods

SetReference

void SetReference(IVerseRef newReference)

A plugin should call this to notify its parent window if its notion of the current reference changes.

---

SetTitle

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 will be lost when regenerated.