VisualPlugin

Overview

The VisualPlugin is a base class for a Hydra WinForms visual plugins. You will use this class as a base for your own visual plugins, please refere to this article for more information about visual plugins.

Location


 

constructor

Creates an instance of the class.

 

constructor

 

VisualPlugin()

 

init()

 

Sub New()

ActionExecute

This event is fired before an action starts to execute. Delprecated use induvidual event of Action class.

 

event ActionExecute: ActionExecuteEventHandler
delegate:  method ActionExecute(sender: Object; e: ActionExecuteEventArgs)

 

delegate ActionExecuteEventHandler ActionExecute()
delegate:  void ActionExecute(Object sender, ActionExecuteEventArgs e)

 

__event ActionExecuteEventHandler: ActionExecute!
delegate:  func ActionExecute(_ sender: Object, _ e: ActionExecuteEventArgs)

 

Event ActionExecute As ActionExecuteEventHandler
delegate:  Sub ActionExecute(sender As Object, e As ActionExecuteEventArgs)

Actions

Reference to a list of actions associated with the plugin.

 

property Actions: ActionList read;

 

ActionList Actions { get; }

 

var Actions: ActionList { get{} }

 

ReadOnly Property Actions() As ActionList

ChildSelectNextControl  protected

 

method ChildSelectNextControl(container: ContainerControl; forward: Boolean; tabStopOnly: Boolean; nested: Boolean; wrap: Boolean): Boolean

 

Boolean ChildSelectNextControl(ContainerControl container, Boolean forward, Boolean tabStopOnly, Boolean nested, Boolean wrap)

 

func ChildSelectNextControl(_ container: ContainerControl, _ forward: Boolean, _ tabStopOnly: Boolean, _ nested: Boolean, _ wrap: Boolean) -> Boolean

 

Function ChildSelectNextControl(container As ContainerControl, forward As Boolean, tabStopOnly As Boolean, nested As Boolean, wrap As Boolean) As Boolean

Parameters:

  • container:
  • forward:
  • tabStopOnly:
  • nested:
  • wrap:

Host  protected

Gets of sets reference to a host instance.

 

property Host: IHYCrossPlatformHost read write;

 

IHYCrossPlatformHost Host { get; set; }

 

var Host: IHYCrossPlatformHost { get{} set{} }

 

Property Host() As IHYCrossPlatformHost

HostChanged

This event if fired whenever reference to a host is changed.

 

event HostChanged: HostChangedEventHandler
delegate:  method HostChanged(sender: Object; e: HostChangedEventArgs)

 

delegate HostChangedEventHandler HostChanged()
delegate:  void HostChanged(Object sender, HostChangedEventArgs e)

 

__event HostChangedEventHandler: HostChanged!
delegate:  func HostChanged(_ sender: Object, _ e: HostChangedEventArgs)

 

Event HostChanged As HostChangedEventHandler
delegate:  Sub HostChanged(sender As Object, e As HostChangedEventArgs)

Images

Represents the list of images which can be used in toolbars and menu.

 

property Images: ImageList read write;

 

ImageList Images { get; set; }

 

var Images: ImageList { get{} set{} }

 

Property Images() As ImageList

InstanceID  protected

Gets the InstanceID to determine the run-time identifier of the plugin instance. Deprecated.

 

property InstanceID: Int32 read;

 

Int32 InstanceID { get; }

 

var InstanceID: Int32 { get{} }

 

ReadOnly Property InstanceID() As Int32

KeyPreview

Gets or sets a value indicating whether the plugin will receive key events before the event is passed to the control that has focus.

 

[DefaultValue(false)]
property KeyPreview: Boolean read write;

 

[DefaultValue(false)]
Boolean KeyPreview { get; set; }

 

@DefaultValue(false)
var KeyPreview: Boolean { get{} set{} }

 

<DefaultValue(false)>
Property KeyPreview() As Boolean

OnParentChanged  protected

Overriden. Raises the ParentChanged event.

 

method OnParentChanged(e: EventArgs)

 

void OnParentChanged(EventArgs e)

 

func OnParentChanged(_ e: EventArgs)

 

Sub OnParentChanged(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

ProcessKeyPreview  protected

Overriden. Previews a keyboard message.

 

method ProcessKeyPreview(var m: Message): Boolean

 

Boolean ProcessKeyPreview(ref Message m)

 

func ProcessKeyPreview(_ m: inout Message) -> Boolean

 

Function ProcessKeyPreview(ByRef m As Message) As Boolean

Parameters:

  • m: A message, passed by reference, that represents the window message to process.

TabKeyPressed

 

event TabKeyPressed: TabKeyPressedEventHandler
delegate:  method TabKeyPressed(sender: Object; e: TabKeyPressedEventArgs)

 

delegate TabKeyPressedEventHandler TabKeyPressed()
delegate:  void TabKeyPressed(Object sender, TabKeyPressedEventArgs e)

 

__event TabKeyPressedEventHandler: TabKeyPressed!
delegate:  func TabKeyPressed(_ sender: Object, _ e: TabKeyPressedEventArgs)

 

Event TabKeyPressed As TabKeyPressedEventHandler
delegate:  Sub TabKeyPressed(sender As Object, e As TabKeyPressedEventArgs)

Toolbars

Represents the list of toolbars.

 

property Toolbars: ToolbarList read;

 

ToolbarList Toolbars { get; }

 

var Toolbars: ToolbarList { get{} }

 

ReadOnly Property Toolbars() As ToolbarList

UseLegacyActions

Gets or sets a value indicating whether the plugin should use legacy actions handling mechanism.

 

[DefaultValue(false)]
property UseLegacyActions: Boolean read write;

 

[DefaultValue(false)]
Boolean UseLegacyActions { get; set; }

 

@DefaultValue(false)
var UseLegacyActions: Boolean { get{} set{} }

 

<DefaultValue(false)>
Property UseLegacyActions() As Boolean

 

Actions

Reference to a list of actions associated with the plugin.

 

property Actions: ActionList read;

 

ActionList Actions { get; }

 

var Actions: ActionList { get{} }

 

ReadOnly Property Actions() As ActionList

Host  protected

Gets of sets reference to a host instance.

 

property Host: IHYCrossPlatformHost read write;

 

IHYCrossPlatformHost Host { get; set; }

 

var Host: IHYCrossPlatformHost { get{} set{} }

 

Property Host() As IHYCrossPlatformHost

Images

Represents the list of images which can be used in toolbars and menu.

 

property Images: ImageList read write;

 

ImageList Images { get; set; }

 

var Images: ImageList { get{} set{} }

 

Property Images() As ImageList

InstanceID  protected

Gets the InstanceID to determine the run-time identifier of the plugin instance. Deprecated.

 

property InstanceID: Int32 read;

 

Int32 InstanceID { get; }

 

var InstanceID: Int32 { get{} }

 

ReadOnly Property InstanceID() As Int32

KeyPreview

Gets or sets a value indicating whether the plugin will receive key events before the event is passed to the control that has focus.

 

[DefaultValue(false)]
property KeyPreview: Boolean read write;

 

[DefaultValue(false)]
Boolean KeyPreview { get; set; }

 

@DefaultValue(false)
var KeyPreview: Boolean { get{} set{} }

 

<DefaultValue(false)>
Property KeyPreview() As Boolean

Toolbars

Represents the list of toolbars.

 

property Toolbars: ToolbarList read;

 

ToolbarList Toolbars { get; }

 

var Toolbars: ToolbarList { get{} }

 

ReadOnly Property Toolbars() As ToolbarList

UseLegacyActions

Gets or sets a value indicating whether the plugin should use legacy actions handling mechanism.

 

[DefaultValue(false)]
property UseLegacyActions: Boolean read write;

 

[DefaultValue(false)]
Boolean UseLegacyActions { get; set; }

 

@DefaultValue(false)
var UseLegacyActions: Boolean { get{} set{} }

 

<DefaultValue(false)>
Property UseLegacyActions() As Boolean

 

constructor

Creates an instance of the class.

 

constructor

 

VisualPlugin()

 

init()

 

Sub New()

ChildSelectNextControl  protected

 

method ChildSelectNextControl(container: ContainerControl; forward: Boolean; tabStopOnly: Boolean; nested: Boolean; wrap: Boolean): Boolean

 

Boolean ChildSelectNextControl(ContainerControl container, Boolean forward, Boolean tabStopOnly, Boolean nested, Boolean wrap)

 

func ChildSelectNextControl(_ container: ContainerControl, _ forward: Boolean, _ tabStopOnly: Boolean, _ nested: Boolean, _ wrap: Boolean) -> Boolean

 

Function ChildSelectNextControl(container As ContainerControl, forward As Boolean, tabStopOnly As Boolean, nested As Boolean, wrap As Boolean) As Boolean

Parameters:

  • container:
  • forward:
  • tabStopOnly:
  • nested:
  • wrap:

OnParentChanged  protected

Overriden. Raises the ParentChanged event.

 

method OnParentChanged(e: EventArgs)

 

void OnParentChanged(EventArgs e)

 

func OnParentChanged(_ e: EventArgs)

 

Sub OnParentChanged(e As EventArgs)

Parameters:

  • e: An EventArgs that contains the event data.

ProcessKeyPreview  protected

Overriden. Previews a keyboard message.

 

method ProcessKeyPreview(var m: Message): Boolean

 

Boolean ProcessKeyPreview(ref Message m)

 

func ProcessKeyPreview(_ m: inout Message) -> Boolean

 

Function ProcessKeyPreview(ByRef m As Message) As Boolean

Parameters:

  • m: A message, passed by reference, that represents the window message to process.

 

ActionExecute

This event is fired before an action starts to execute. Delprecated use induvidual event of Action class.

 

event ActionExecute: ActionExecuteEventHandler
delegate:  method ActionExecute(sender: Object; e: ActionExecuteEventArgs)

 

delegate ActionExecuteEventHandler ActionExecute()
delegate:  void ActionExecute(Object sender, ActionExecuteEventArgs e)

 

__event ActionExecuteEventHandler: ActionExecute!
delegate:  func ActionExecute(_ sender: Object, _ e: ActionExecuteEventArgs)

 

Event ActionExecute As ActionExecuteEventHandler
delegate:  Sub ActionExecute(sender As Object, e As ActionExecuteEventArgs)

HostChanged

This event if fired whenever reference to a host is changed.

 

event HostChanged: HostChangedEventHandler
delegate:  method HostChanged(sender: Object; e: HostChangedEventArgs)

 

delegate HostChangedEventHandler HostChanged()
delegate:  void HostChanged(Object sender, HostChangedEventArgs e)

 

__event HostChangedEventHandler: HostChanged!
delegate:  func HostChanged(_ sender: Object, _ e: HostChangedEventArgs)

 

Event HostChanged As HostChangedEventHandler
delegate:  Sub HostChanged(sender As Object, e As HostChangedEventArgs)

TabKeyPressed

 

event TabKeyPressed: TabKeyPressedEventHandler
delegate:  method TabKeyPressed(sender: Object; e: TabKeyPressedEventArgs)

 

delegate TabKeyPressedEventHandler TabKeyPressed()
delegate:  void TabKeyPressed(Object sender, TabKeyPressedEventArgs e)

 

__event TabKeyPressedEventHandler: TabKeyPressed!
delegate:  func TabKeyPressed(_ sender: Object, _ e: TabKeyPressedEventArgs)

 

Event TabKeyPressed As TabKeyPressedEventHandler
delegate:  Sub TabKeyPressed(sender As Object, e As TabKeyPressedEventArgs)