INonVisualPlugin

Overview

Base interface for non-visual Hydra plugins. It is implemented by the NonVisualPlugin class. The INonVisualPlugin interface is used for the encapsulation of processes. It has methods that let host applications start, pause, resume and stop processes encapsulated by the non-visual plugin.

Location


 

Host    (declared in IPlugin)

Gets or sets the host interface of the host application.

 

property Host: IHYCrossPlatformHost read write;

 

IHYCrossPlatformHost Host { get; set; }

 

Property Host() As IHYCrossPlatformHost

InstanceID    (declared in IPlugin)

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

 

property InstanceID: Int32 read;

 

Int32 InstanceID { get; }

 

ReadOnly Property InstanceID() As Int32

Pause

Pauses executing the non-visual plugin. As implemented by NonVisualPlugin, Pause will just invoke the OnPause event.

 

method Pause

 

void Pause()

 

Sub Pause()

Resume

Resumes executing the non-visual plugin. As implemented by the NonVisualPlugin, Resume will just invoke the OnResume event.

 

method Resume

 

void Resume()

 

Sub Resume()

Start

Starts executing the non-visual plugin. As implemented by the NonVisualPlugin, Start will just invoke the OnStart event.

 

method Start

 

void Start()

 

Sub Start()

Stop

Stops executing the non-visual plugin. As implemented by the NonVisualPlugin, Stop will just invoke the OnStop event.

 

method Stop

 

void Stop()

 

Sub Stop()

 

Host    (declared in IPlugin)

Gets or sets the host interface of the host application.

 

property Host: IHYCrossPlatformHost read write;

 

IHYCrossPlatformHost Host { get; set; }

 

Property Host() As IHYCrossPlatformHost

InstanceID    (declared in IPlugin)

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

 

property InstanceID: Int32 read;

 

Int32 InstanceID { get; }

 

ReadOnly Property InstanceID() As Int32

 

Pause

Pauses executing the non-visual plugin. As implemented by NonVisualPlugin, Pause will just invoke the OnPause event.

 

method Pause

 

void Pause()

 

Sub Pause()

Resume

Resumes executing the non-visual plugin. As implemented by the NonVisualPlugin, Resume will just invoke the OnResume event.

 

method Resume

 

void Resume()

 

Sub Resume()

Start

Starts executing the non-visual plugin. As implemented by the NonVisualPlugin, Start will just invoke the OnStart event.

 

method Start

 

void Start()

 

Sub Start()

Stop

Stops executing the non-visual plugin. As implemented by the NonVisualPlugin, Stop will just invoke the OnStop event.

 

method Stop

 

void Stop()

 

Sub Stop()