[This is preliminary documentation and is subject to change.]
Core functions of the main MDI application host Form.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IHostWindow
Public Interface IHostWindow
public interface class IHostWindow
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | ActiveChildForm |
A reference to the active child form.
|
 | AddPluginCommand<(Of <(TCommand>)>)()()() |
Adds an ICommand to the plugins menu.
|
| AddToolStripCommand<(Of <(TCommand>)>)(Nullable<(Of <(Int32>)>)) |
Adds a command based button to the tool strip by index.
|
| AddToolStripSeperator(Nullable<(Of <(Int32>)>)) |
Adds a seperator to the tool strip by index.
|
| DatabaseInspector |
A reference to the database inspector window if open.
|
| DisplayDockedForm(DockContent) |
Displays the frm in the host window.
|
| DisplayMessageBox(Form, String, String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, MessageBoxOptions, String, String) | Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file and Help keyword. |
| DisplaySimpleMessageBox(Form, String, String) | Displays an "OK" message box with the specified text and caption. |
| Instance |
The instance of the host form.
|
| SetArguements(array<String>[]()[]) |
A testable way to pass command line arguements to the application.
|
| SetPointerState(Cursor) |
Sets the application cursor to cursor.
|
| SetStatus(Form, String) |
Sets the status text of the host.
|
| ShowDatabaseInspector(IDatabaseInspector, DockState) |
Displays (and replaces if required) the database inspactor window.
|
| ShowToolWindow(DockContent, DockState) |
Displays a "tool" window, like the database inspector etc.
|
| ToolStrip |
Provides access to the host windows tool strip control.
|