VisualPlugin Class (RemObjects.Hydra.WPF)

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 VisualPlugin is a base class for a Hydra WPF 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

• Assembly: RemObjects.Hydra.WPF.dll
• Namespace: RemObjects.Hydra.WPF
• Ancestry: System.Windows.Controls.UserControl | VisualPlugin

Implemented interfaces

• IHYCrossPlatformVisualPlugin
• IHYCrossPlatformVisualPluginEx
• IPlugin
• IWinFormsVisualPlugin
• IWPFVisualPlugin

Properties

FadeDuration
Duration of the fade effect in milliseconds. Prism:   property FadeDuration: Int32 read write C#:   Int32 FadeDuration { get; set; } VB:   Property FadeDuration As Int32
FadeOnShow
Defines whether the fade effect is shown or not. Prism:   property FadeOnShow: Boolean read write C#:   Boolean FadeOnShow { get; set; } VB:   Property FadeOnShow As Boolean
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
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
WinformHost   protected
Reference to the underlying host control. Prism:   property WinformHost: ElementHost read C#:   ElementHost WinformHost { get; } VB:   Property ReadOnly WinformHost As ElementHost

Instance Methods

constructor
Creates a new instance of the class. Oxygene:   constructor C#:   constructor() VB:   Sub New
ChildSelectNextControl   protected
This method is called by the host whenever Tab key is pressed. VisualPlugin handles this method internally to transfer focus between controls, but you can override this method to implement custom logic. Oxygene:   method ChildSelectNextControl(aForward: Boolean): Boolean C#:   Boolean ChildSelectNextControl(Boolean aForward) VB:   Function ChildSelectNextControl(aForward As Boolean) As Boolean Parameters: aForward: True to move forward in the tab order; false to move backward in the tab order.
OnPreviewKeyDown   protected
Overriden. Invoked when an unhandled Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Oxygene:   method OnPreviewKeyDown(e: KeyEventArgs) C#:   void OnPreviewKeyDown(KeyEventArgs e) VB:   Sub OnPreviewKeyDown(e As KeyEventArgs) Parameters: e: The KeyEventArgs that contains the event data.

Events

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)

See Also

• VisualPlugin Class
  • RemObjects.Hydra
  • RemObjects.Hydra.WPF
• 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