HostPanel

Overview

A special panel which is used by the host application to show Hydra visual plugins. You will use this control to display content of a every visual plugin.

Location


 

constructor

Creates an instance of the control.

 

constructor

 

HostPanel()

 

Sub New()

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

HostPlugin

Loads the specified plugin to the HostPanel.

 

method HostPlugin(aPlugin: IHYCrossPlatformInterface)

 

void HostPlugin(IHYCrossPlatformInterface aPlugin)

 

Sub HostPlugin(aPlugin As IHYCrossPlatformInterface)

Parameters:

  • aPlugin: Reference to a plugin.

IsInputKey  protected

Checks whether given key is an input or control key.

 

method IsInputKey(keyData: Keys): Boolean

 

Boolean IsInputKey(Keys keyData)

 

Function IsInputKey(keyData As Keys) As Boolean

Parameters:

  • keyData: Key data.

OnEnter  protected

Overriden. Raises the Enter event.

 

method OnEnter(e: EventArgs)

 

void OnEnter(EventArgs e)

 

Sub OnEnter(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

OnLeave  protected

Overriden. Raises the Leave event.

 

method OnLeave(e: EventArgs)

 

void OnLeave(EventArgs e)

 

Sub OnLeave(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

OnPaint  protected

Overriden. Raises the Paint event.

 

method OnPaint(pe: PaintEventArgs)

 

void OnPaint(PaintEventArgs pe)

 

Sub OnPaint(pe As PaintEventArgs)

Parameters:

  • pe: A PaintEventArgs that contains the event data.

OnResize  protected

Overriden. Raises the Resize event.

 

method OnResize(e: EventArgs)

 

void OnResize(EventArgs e)

 

Sub OnResize(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

ProcessCmdKey  protected

Overriden. Processes a command key.

 

method ProcessCmdKey(var msg: Message; keyData: Keys): Boolean

 

Boolean ProcessCmdKey(ref Message msg, Keys keyData)

 

Function ProcessCmdKey(ByRef msg As Message, keyData As Keys) As Boolean

Parameters:

  • msg: A Message, passed by reference, that represents the window message to process.
  • keyData: One of the Keys values that represents the key to process.

ProcessDialogKey  protected

Overriden. Processes a dialog key.

 

method ProcessDialogKey(keyData: Keys): Boolean

 

Boolean ProcessDialogKey(Keys keyData)

 

Function ProcessDialogKey(keyData As Keys) As Boolean

Parameters:

  • keyData: One of the Keys values that represents the key to process.

ProcessMnemonic  protected

Overriden. Processes a mnemonic character.

 

method ProcessMnemonic(charCode: Char): Boolean

 

Boolean ProcessMnemonic(Char charCode)

 

Function ProcessMnemonic(charCode As Char) As Boolean

Parameters:

  • charCode: The character to process.

ShowBorder

Defines whether control will draw an additional border.

 

property ShowBorder: Boolean read write;

 

Boolean ShowBorder { get; set; }

 

Property ShowBorder() As Boolean

ShowText

Defines whether control will draw a title.

 

property ShowText: Boolean read write;

 

Boolean ShowText { get; set; }

 

Property ShowText() As Boolean

TabStop

Gets or sets whether the panel can receive focus and participate in the tabbing sequence.

 

property TabStop: Boolean read write;

 

Boolean TabStop { get; set; }

 

Property TabStop() As Boolean

Text

Title of the control.

 

property Text: String read write;

 

String Text { get; set; }

 

Property Text() As String

UnhostPlugin

Unloads the previously loaded plugin.

 

method UnhostPlugin

 

void UnhostPlugin()

 

Sub UnhostPlugin()

WndProc  protected

Overriden. Processes Windows messages.

 

method WndProc(var m: Message)

 

void WndProc(ref Message m)

 

Sub WndProc(ByRef m As Message)

Parameters:

  • m: The Windows Message to process.

 

ShowBorder

Defines whether control will draw an additional border.

 

property ShowBorder: Boolean read write;

 

Boolean ShowBorder { get; set; }

 

Property ShowBorder() As Boolean

ShowText

Defines whether control will draw a title.

 

property ShowText: Boolean read write;

 

Boolean ShowText { get; set; }

 

Property ShowText() As Boolean

TabStop

Gets or sets whether the panel can receive focus and participate in the tabbing sequence.

 

property TabStop: Boolean read write;

 

Boolean TabStop { get; set; }

 

Property TabStop() As Boolean

Text

Title of the control.

 

property Text: String read write;

 

String Text { get; set; }

 

Property Text() As String

 

constructor

Creates an instance of the control.

 

constructor

 

HostPanel()

 

Sub New()

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

HostPlugin

Loads the specified plugin to the HostPanel.

 

method HostPlugin(aPlugin: IHYCrossPlatformInterface)

 

void HostPlugin(IHYCrossPlatformInterface aPlugin)

 

Sub HostPlugin(aPlugin As IHYCrossPlatformInterface)

Parameters:

  • aPlugin: Reference to a plugin.

IsInputKey  protected

Checks whether given key is an input or control key.

 

method IsInputKey(keyData: Keys): Boolean

 

Boolean IsInputKey(Keys keyData)

 

Function IsInputKey(keyData As Keys) As Boolean

Parameters:

  • keyData: Key data.

OnEnter  protected

Overriden. Raises the Enter event.

 

method OnEnter(e: EventArgs)

 

void OnEnter(EventArgs e)

 

Sub OnEnter(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

OnLeave  protected

Overriden. Raises the Leave event.

 

method OnLeave(e: EventArgs)

 

void OnLeave(EventArgs e)

 

Sub OnLeave(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

OnPaint  protected

Overriden. Raises the Paint event.

 

method OnPaint(pe: PaintEventArgs)

 

void OnPaint(PaintEventArgs pe)

 

Sub OnPaint(pe As PaintEventArgs)

Parameters:

  • pe: A PaintEventArgs that contains the event data.

OnResize  protected

Overriden. Raises the Resize event.

 

method OnResize(e: EventArgs)

 

void OnResize(EventArgs e)

 

Sub OnResize(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

ProcessCmdKey  protected

Overriden. Processes a command key.

 

method ProcessCmdKey(var msg: Message; keyData: Keys): Boolean

 

Boolean ProcessCmdKey(ref Message msg, Keys keyData)

 

Function ProcessCmdKey(ByRef msg As Message, keyData As Keys) As Boolean

Parameters:

  • msg: A Message, passed by reference, that represents the window message to process.
  • keyData: One of the Keys values that represents the key to process.

ProcessDialogKey  protected

Overriden. Processes a dialog key.

 

method ProcessDialogKey(keyData: Keys): Boolean

 

Boolean ProcessDialogKey(Keys keyData)

 

Function ProcessDialogKey(keyData As Keys) As Boolean

Parameters:

  • keyData: One of the Keys values that represents the key to process.

ProcessMnemonic  protected

Overriden. Processes a mnemonic character.

 

method ProcessMnemonic(charCode: Char): Boolean

 

Boolean ProcessMnemonic(Char charCode)

 

Function ProcessMnemonic(charCode As Char) As Boolean

Parameters:

  • charCode: The character to process.

UnhostPlugin

Unloads the previously loaded plugin.

 

method UnhostPlugin

 

void UnhostPlugin()

 

Sub UnhostPlugin()

WndProc  protected

Overriden. Processes Windows messages.

 

method WndProc(var m: Message)

 

void WndProc(ref Message m)

 

Sub WndProc(ByRef m As Message)

Parameters:

  • m: The Windows Message to process.