Class Plugin

The plugin class.

Inheritance
System.Object
Plugin
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: DesktopMagicPluginAPI
Assembly: DesktopMagicPluginAPI.dll
Syntax
public abstract class Plugin

Properties

| Improve this Doc View Source

Application

Informations about the main application.

Declaration
public IPluginData Application { get; set; }
Property Value
Type Description
IPluginData
| Improve this Doc View Source

RenderQuality

Gets or sets the render quality of the bitmap image.

Declaration
public virtual RenderQuality RenderQuality { get; set; }
Property Value
Type Description
RenderQuality
| Improve this Doc View Source

UpdateInterval

Gets or sets the interval, expressed in milliseconds, at which to call the Main() method.

Declaration
public virtual int UpdateInterval { get; set; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Main()

Occurs when the UpdateInterval elapses.

Declaration
public abstract Bitmap Main()
Returns
Type Description
System.Drawing.Bitmap
| Improve this Doc View Source

OnMouseClick(Point, MouseButton)

Occurs when the window is clicked by the mouse.

Declaration
public virtual void OnMouseClick(Point position, MouseButton mouseButton)
Parameters
Type Name Description
System.Drawing.Point position

The x- and y-coordinates of the mouse pointer position relative to the plugin window.
MouseButton mouseButton

The button associated with the event.
| Improve this Doc View Source

OnMouseMove(Point)

Occurs when the mouse pointer is moved over the control.

Declaration
public virtual void OnMouseMove(Point position)
Parameters
Type Name Description
System.Drawing.Point position

The x- and y-coordinates of the mouse pointer position relative to the plugin window.
| Improve this Doc View Source

OnMouseWheel(Point, Int32)

Occurs when the user rotates the mouse wheel while the mouse pointer is over this element.

Declaration
public virtual void OnMouseWheel(Point position, int delta)
Parameters
Type Name Description
System.Drawing.Point position

The x- and y-coordinates of the mouse pointer position relative to the plugin window.
System.Int32 delta

A value that indicates the amount that the mouse wheel has changed.
| Improve this Doc View Source

Start()

Occurs once when the plugin gets activated.

Declaration
public virtual void Start()
| Improve this Doc View Source

Stop()

Occurs once when the plugin gets deactivated.

Declaration
public virtual void Stop()