NonVisualPlugin Class

This is a Library topic for Hydra for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

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

• Assembly: RemObjects.Hydra.dll
• Namespace: RemObjects.Hydra
• Ancestry: System.ComponentModel.Component | NonVisualPlugin

Implemented interfaces

• IHYCrossPlatformActionList
• IHYCrossPlatformActions
• IHYCrossPlatformNonVisualPlugin
• INonVisualPlugin
• IPlugin
• IPluginActions

Properties

Actions
Reference to a list of actions associated with the plugin. Prism:   property Actions: ActionList read C#:   ActionList Actions { get; } VB:   Property ReadOnly Actions As ActionList
Host   protected
Gets of sets reference to a host instance. Prism:   property Host: IHYCrossPlatformHost read write C#:   IHYCrossPlatformHost Host { get; set; } VB:   Property Host As IHYCrossPlatformHost
Images
Represents the list of images which can be used in toolbars. Prism:   property Images: ImageList read write C#:   ImageList Images { get; set; } VB:   Property Images As ImageList
InstanceID   protected
Gets the InstanceID to determine the run-time identifier of the plugin instance. Deprecated. Prism:   property InstanceID: Int32 read C#:   Int32 InstanceID { get; } VB:   Property ReadOnly InstanceID As Int32
Toolbars
Represents the list of toolbars. Prism:   property Toolbars: ToolbarList read C#:   ToolbarList Toolbars { get; } VB:   Property ReadOnly Toolbars As ToolbarList
UseLegacyActions
Gets or sets a value indicating whether the plugin should use legacy actions handling mechanism. Prism:   property UseLegacyActions: Boolean read write C#:   Boolean UseLegacyActions { get; set; } VB:   Property UseLegacyActions As Boolean

Instance Methods

constructor
Creates a new instance of the class. Oxygene:   constructor C#:   constructor() VB:   Sub New

Events

ActionExecute
This event is fired before an action starts to execute. Delprecated use induvidual event of Action class. Oxygene:   event ActionExecute: ActionExecuteEventHandler delegate: method Invoke(sender: Object; e: ActionExecuteEventArgs) C#:   event ActionExecuteEventHandler ActionExecute delegate: void Invoke(Object sender, ActionExecuteEventArgs e) VB:   Event ActionExecute As ActionExecuteEventHandler delegate: Sub Invoke(sender As Object, e As ActionExecuteEventArgs)
HostChanged
This event if fired whenever reference to a host is changed. Oxygene:   event HostChanged: HostChangedEventHandler delegate: method Invoke(sender: Object; e: HostChangedEventArgs) C#:   event HostChangedEventHandler HostChanged delegate: void Invoke(Object sender, HostChangedEventArgs e) VB:   Event HostChanged As HostChangedEventHandler delegate: Sub Invoke(sender As Object, e As HostChangedEventArgs)
OnPause
Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Pause method. Oxygene:   event OnPause: EventHandler C#:   event EventHandler OnPause VB:   Event OnPause As EventHandler
OnResume
Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Resume method. Oxygene:   event OnResume: EventHandler C#:   event EventHandler OnResume VB:   Event OnResume As EventHandler
OnStart
Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Start method. Oxygene:   event OnStart: EventHandler C#:   event EventHandler OnStart VB:   Event OnStart As EventHandler
OnStop
Fires whenever host calls IHYCrossPlatformNonVisualPlugin.Stop method. Oxygene:   event OnStop: EventHandler C#:   event EventHandler OnStop VB:   Event OnStop As EventHandler

See Also

• RemObjects.Hydra.VisualPlugin
• ActionList
• ToolbarList
• Lists
  • Hydra for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
  • Hydra for Delphi:   Interfaces — Classes — Enums — Aliases — Implements

Product: RemObjects Hydra
Current version: Hydra 4.0

Glossary — Architecture — Articles — Library — Samples