VisualPlugin
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
- Reference: RemObjects.Hydra.WPF.dll
- Namespace: RemObjects.Hydra.WPF
- Ancestry: UserControl | VisualPlugin
constructor
Creates a new instance of the class.
constructor
VisualPlugin()
Sub New()
ChildSelectNextControl protected
method ChildSelectNextControl(forward: Boolean): Boolean
Boolean ChildSelectNextControl(Boolean forward)
Function ChildSelectNextControl(forward As Boolean) As Boolean
Parameters:
- forward:
FadeDuration
Duration of the fade effect in milliseconds.
property FadeDuration: Int32 read write;
Int32 FadeDuration { get; set; }
Property FadeDuration() As Int32
FadeOnShow
Defines whether the fade effect is shown or not.
property FadeOnShow: Boolean read write;
Boolean FadeOnShow { get; set; }
Property FadeOnShow() As Boolean
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)
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
IsTabAcceptedByControl protected
method IsTabAcceptedByControl(control: Object; leftCtrl: Boolean; rightCtrl: Boolean; leftShift: Boolean; rightShift: Boolean): Boolean
Boolean IsTabAcceptedByControl(Object control, Boolean leftCtrl, Boolean rightCtrl, Boolean leftShift, Boolean rightShift)
Function IsTabAcceptedByControl(control As Object, leftCtrl As Boolean, rightCtrl As Boolean, leftShift As Boolean, rightShift As Boolean) As Boolean
Parameters:
- control:
- leftCtrl:
- rightCtrl:
- leftShift:
- rightShift:
OnPreviewKeyDown protected
Overriden. Invoked when an unhandled Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class.
method OnPreviewKeyDown(e: KeyEventArgs)
void OnPreviewKeyDown(KeyEventArgs e)
Sub OnPreviewKeyDown(e As KeyEventArgs)
Parameters:
- e: The KeyEventArgs that contains the event data.
TabKeyPressed
event TabKeyPressed: TabKeyPressedEventHandler;
delegate: method TabKeyPressed(sender: Object; e: TabKeyPressedEventArgs)
delegate TabKeyPressedEventHandler TabKeyPressed()
delegate: void TabKeyPressed(Object sender, TabKeyPressedEventArgs e)
Event TabKeyPressed As TabKeyPressedEventHandler
delegate: Sub TabKeyPressed(sender As Object, e As TabKeyPressedEventArgs)
WinFormsHost protected
property WinFormsHost: ElementHost read;
ElementHost WinFormsHost { get; }
ReadOnly Property WinFormsHost() As ElementHost
FadeDuration
Duration of the fade effect in milliseconds.
property FadeDuration: Int32 read write;
Int32 FadeDuration { get; set; }
Property FadeDuration() As Int32
FadeOnShow
Defines whether the fade effect is shown or not.
property FadeOnShow: Boolean read write;
Boolean FadeOnShow { get; set; }
Property FadeOnShow() As Boolean
Host protected
Gets of sets reference to a host instance.
property Host: IHYCrossPlatformHost read write;
IHYCrossPlatformHost Host { get; set; }
Property Host() As IHYCrossPlatformHost
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
WinFormsHost protected
property WinFormsHost: ElementHost read;
ElementHost WinFormsHost { get; }
ReadOnly Property WinFormsHost() As ElementHost
constructor
Creates a new instance of the class.
constructor
VisualPlugin()
Sub New()
ChildSelectNextControl protected
method ChildSelectNextControl(forward: Boolean): Boolean
Boolean ChildSelectNextControl(Boolean forward)
Function ChildSelectNextControl(forward As Boolean) As Boolean
Parameters:
- forward:
IsTabAcceptedByControl protected
method IsTabAcceptedByControl(control: Object; leftCtrl: Boolean; rightCtrl: Boolean; leftShift: Boolean; rightShift: Boolean): Boolean
Boolean IsTabAcceptedByControl(Object control, Boolean leftCtrl, Boolean rightCtrl, Boolean leftShift, Boolean rightShift)
Function IsTabAcceptedByControl(control As Object, leftCtrl As Boolean, rightCtrl As Boolean, leftShift As Boolean, rightShift As Boolean) As Boolean
Parameters:
- control:
- leftCtrl:
- rightCtrl:
- leftShift:
- rightShift:
OnPreviewKeyDown protected
Overriden. Invoked when an unhandled Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class.
method OnPreviewKeyDown(e: KeyEventArgs)
void OnPreviewKeyDown(KeyEventArgs e)
Sub OnPreviewKeyDown(e As KeyEventArgs)
Parameters:
- e: The KeyEventArgs that contains the event data.
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)
TabKeyPressed
event TabKeyPressed: TabKeyPressedEventHandler;
delegate: method TabKeyPressed(sender: Object; e: TabKeyPressedEventArgs)
delegate TabKeyPressedEventHandler TabKeyPressed()
delegate: void TabKeyPressed(Object sender, TabKeyPressedEventArgs e)
Event TabKeyPressed As TabKeyPressedEventHandler
delegate: Sub TabKeyPressed(sender As Object, e As TabKeyPressedEventArgs)
- RemObjects.Hydra
- RemObjects.Hydra.WPF