NonVisualPlugin

Overview

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

Location


 

constructor

Creates a new instance of the class.

 

constructor

 

NonVisualPlugin()

 

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 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; }

 

ReadOnly Property Actions() As ActionList

add_ActionExecute

 

method add_ActionExecute(value: ActionExecuteEventHandler)

 

void add_ActionExecute(ActionExecuteEventHandler value)

 

Sub add_ActionExecute(value As ActionExecuteEventHandler)

Parameters:

  • value:

add_HostChanged

 

method add_HostChanged(value: HostChangedEventHandler)

 

void add_HostChanged(HostChangedEventHandler value)

 

Sub add_HostChanged(value As HostChangedEventHandler)

Parameters:

  • value:

add_OnPause

 

method add_OnPause(value: EventHandler)

 

void add_OnPause(EventHandler value)

 

Sub add_OnPause(value As EventHandler)

Parameters:

  • value:

add_OnResume

 

method add_OnResume(value: EventHandler)

 

void add_OnResume(EventHandler value)

 

Sub add_OnResume(value As EventHandler)

Parameters:

  • value:

add_OnStart

 

method add_OnStart(value: EventHandler)

 

void add_OnStart(EventHandler value)

 

Sub add_OnStart(value As EventHandler)

Parameters:

  • value:

add_OnStop

 

method add_OnStop(value: EventHandler)

 

void add_OnStop(EventHandler value)

 

Sub add_OnStop(value As EventHandler)

Parameters:

  • value:

Host  protected

Gets of sets reference to a host instance.

 

property Host: IHYCrossPlatformHost read write;

 

IHYCrossPlatformHost Host { 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 HostChanged As HostChangedEventHandler
delegate: Sub HostChanged(sender As Object, e As HostChangedEventArgs)

Images

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

 

property Images: ImageList read write;

 

ImageList Images { 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; }

 

ReadOnly Property InstanceID() As Int32

OnPause

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Pause method.

 

event OnPause: EventHandler;

 

delegate EventHandler OnPause()

 

Event OnPause As EventHandler

OnResume

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Resume method.

 

event OnResume: EventHandler;

 

delegate EventHandler OnResume()

 

Event OnResume As EventHandler

OnStart

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Start method.

 

event OnStart: EventHandler;

 

delegate EventHandler OnStart()

 

Event OnStart As EventHandler

OnStop

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Stop method.

 

event OnStop: EventHandler;

 

delegate EventHandler OnStop()

 

Event OnStop As EventHandler

remove_ActionExecute

 

method remove_ActionExecute(value: ActionExecuteEventHandler)

 

void remove_ActionExecute(ActionExecuteEventHandler value)

 

Sub remove_ActionExecute(value As ActionExecuteEventHandler)

Parameters:

  • value:

remove_HostChanged

 

method remove_HostChanged(value: HostChangedEventHandler)

 

void remove_HostChanged(HostChangedEventHandler value)

 

Sub remove_HostChanged(value As HostChangedEventHandler)

Parameters:

  • value:

remove_OnPause

 

method remove_OnPause(value: EventHandler)

 

void remove_OnPause(EventHandler value)

 

Sub remove_OnPause(value As EventHandler)

Parameters:

  • value:

remove_OnResume

 

method remove_OnResume(value: EventHandler)

 

void remove_OnResume(EventHandler value)

 

Sub remove_OnResume(value As EventHandler)

Parameters:

  • value:

remove_OnStart

 

method remove_OnStart(value: EventHandler)

 

void remove_OnStart(EventHandler value)

 

Sub remove_OnStart(value As EventHandler)

Parameters:

  • value:

remove_OnStop

 

method remove_OnStop(value: EventHandler)

 

void remove_OnStop(EventHandler value)

 

Sub remove_OnStop(value As EventHandler)

Parameters:

  • value:

Toolbars

Represents the list of toolbars.

 

property Toolbars: ToolbarList read;

 

ToolbarList Toolbars { get; }

 

ReadOnly Property Toolbars() As ToolbarList

UseLegacyActions

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

 

property UseLegacyActions: Boolean read write;

 

Boolean UseLegacyActions { get; set; }

 

Property UseLegacyActions() As Boolean

 

Actions

Reference to a list of actions associated with the plugin.

 

property Actions: ActionList read;

 

ActionList Actions { 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; }

 

Property Host() As IHYCrossPlatformHost

Images

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

 

property Images: ImageList read write;

 

ImageList Images { 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; }

 

ReadOnly Property InstanceID() As Int32

Toolbars

Represents the list of toolbars.

 

property Toolbars: ToolbarList read;

 

ToolbarList Toolbars { get; }

 

ReadOnly Property Toolbars() As ToolbarList

UseLegacyActions

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

 

property UseLegacyActions: Boolean read write;

 

Boolean UseLegacyActions { get; set; }

 

Property UseLegacyActions() As Boolean

 

constructor

Creates a new instance of the class.

 

constructor

 

NonVisualPlugin()

 

Sub New()

add_ActionExecute

 

method add_ActionExecute(value: ActionExecuteEventHandler)

 

void add_ActionExecute(ActionExecuteEventHandler value)

 

Sub add_ActionExecute(value As ActionExecuteEventHandler)

Parameters:

  • value:

add_HostChanged

 

method add_HostChanged(value: HostChangedEventHandler)

 

void add_HostChanged(HostChangedEventHandler value)

 

Sub add_HostChanged(value As HostChangedEventHandler)

Parameters:

  • value:

add_OnPause

 

method add_OnPause(value: EventHandler)

 

void add_OnPause(EventHandler value)

 

Sub add_OnPause(value As EventHandler)

Parameters:

  • value:

add_OnResume

 

method add_OnResume(value: EventHandler)

 

void add_OnResume(EventHandler value)

 

Sub add_OnResume(value As EventHandler)

Parameters:

  • value:

add_OnStart

 

method add_OnStart(value: EventHandler)

 

void add_OnStart(EventHandler value)

 

Sub add_OnStart(value As EventHandler)

Parameters:

  • value:

add_OnStop

 

method add_OnStop(value: EventHandler)

 

void add_OnStop(EventHandler value)

 

Sub add_OnStop(value As EventHandler)

Parameters:

  • value:

remove_ActionExecute

 

method remove_ActionExecute(value: ActionExecuteEventHandler)

 

void remove_ActionExecute(ActionExecuteEventHandler value)

 

Sub remove_ActionExecute(value As ActionExecuteEventHandler)

Parameters:

  • value:

remove_HostChanged

 

method remove_HostChanged(value: HostChangedEventHandler)

 

void remove_HostChanged(HostChangedEventHandler value)

 

Sub remove_HostChanged(value As HostChangedEventHandler)

Parameters:

  • value:

remove_OnPause

 

method remove_OnPause(value: EventHandler)

 

void remove_OnPause(EventHandler value)

 

Sub remove_OnPause(value As EventHandler)

Parameters:

  • value:

remove_OnResume

 

method remove_OnResume(value: EventHandler)

 

void remove_OnResume(EventHandler value)

 

Sub remove_OnResume(value As EventHandler)

Parameters:

  • value:

remove_OnStart

 

method remove_OnStart(value: EventHandler)

 

void remove_OnStart(EventHandler value)

 

Sub remove_OnStart(value As EventHandler)

Parameters:

  • value:

remove_OnStop

 

method remove_OnStop(value: EventHandler)

 

void remove_OnStop(EventHandler value)

 

Sub remove_OnStop(value As EventHandler)

Parameters:

  • value:

 

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 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 HostChanged As HostChangedEventHandler
delegate: Sub HostChanged(sender As Object, e As HostChangedEventArgs)

OnPause

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Pause method.

 

event OnPause: EventHandler;

 

delegate EventHandler OnPause()

 

Event OnPause As EventHandler

OnResume

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Resume method.

 

event OnResume: EventHandler;

 

delegate EventHandler OnResume()

 

Event OnResume As EventHandler

OnStart

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Start method.

 

event OnStart: EventHandler;

 

delegate EventHandler OnStart()

 

Event OnStart As EventHandler

OnStop

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Stop method.

 

event OnStop: EventHandler;

 

delegate EventHandler OnStop()

 

Event OnStop As EventHandler