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

Reference: RemObjects.Hydra.dll
Namespace: RemObjects.Hydra
Ancestry: Component | NonVisualPlugin

constructor

Creates a new instance of the class.

constructor

NonVisualPlugin()

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

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.

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

OnPause

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Pause method.

event OnPause: EventHandler

delegate EventHandler OnPause()

__event EventHandler: OnPause!

Event OnPause As EventHandler

OnResume

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Resume method.

event OnResume: EventHandler

delegate EventHandler OnResume()

__event EventHandler: OnResume!

Event OnResume As EventHandler

OnStart

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Start method.

event OnStart: EventHandler

delegate EventHandler OnStart()

__event EventHandler: OnStart!

Event OnStart As EventHandler

OnStop

Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Stop method.

event OnStop: EventHandler

delegate EventHandler OnStop()

__event EventHandler: OnStop!

Event OnStop As EventHandler

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