mirror of
https://github.com/Stone-Red-Code/DesktopMagic.git
synced 2026-09-04 17:06:12 +02:00
Added documentation to the DesktopMagicPluginAPI
This commit is contained in:
Stone-Red-Code
@@ -0,0 +1,493 @@
|
||||
<a name='assembly'></a>
|
||||
# DesktopMagicPluginAPI
|
||||
|
||||
## Contents
|
||||
|
||||
- [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button')
|
||||
- [#ctor(value)](#M-DesktopMagicPluginAPI-Inputs-Button-#ctor-System-String- 'DesktopMagicPluginAPI.Inputs.Button.#ctor(System.String)')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-Button-Value 'DesktopMagicPluginAPI.Inputs.Button.Value')
|
||||
- [Click()](#M-DesktopMagicPluginAPI-Inputs-Button-Click 'DesktopMagicPluginAPI.Inputs.Button.Click')
|
||||
- [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox')
|
||||
- [#ctor(value)](#M-DesktopMagicPluginAPI-Inputs-CheckBox-#ctor-System-Boolean- 'DesktopMagicPluginAPI.Inputs.CheckBox.#ctor(System.Boolean)')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-CheckBox-Value 'DesktopMagicPluginAPI.Inputs.CheckBox.Value')
|
||||
- [Element](#T-DesktopMagicPluginAPI-Inputs-Element 'DesktopMagicPluginAPI.Inputs.Element')
|
||||
- [ValueChanged()](#M-DesktopMagicPluginAPI-Inputs-Element-ValueChanged 'DesktopMagicPluginAPI.Inputs.Element.ValueChanged')
|
||||
- [ElementAttribute](#T-DesktopMagicPluginAPI-Inputs-ElementAttribute 'DesktopMagicPluginAPI.Inputs.ElementAttribute')
|
||||
- [#ctor(name,orderIndex)](#M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-String,System-Int32- 'DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.String,System.Int32)')
|
||||
- [#ctor(orderIndex)](#M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-Int32- 'DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.Int32)')
|
||||
- [#ctor()](#M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor 'DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor')
|
||||
- [Name](#P-DesktopMagicPluginAPI-Inputs-ElementAttribute-Name 'DesktopMagicPluginAPI.Inputs.ElementAttribute.Name')
|
||||
- [OrderIndex](#P-DesktopMagicPluginAPI-Inputs-ElementAttribute-OrderIndex 'DesktopMagicPluginAPI.Inputs.ElementAttribute.OrderIndex')
|
||||
- [IPluginData](#T-DesktopMagicPluginAPI-IPluginData 'DesktopMagicPluginAPI.IPluginData')
|
||||
- [Color](#P-DesktopMagicPluginAPI-IPluginData-Color 'DesktopMagicPluginAPI.IPluginData.Color')
|
||||
- [Font](#P-DesktopMagicPluginAPI-IPluginData-Font 'DesktopMagicPluginAPI.IPluginData.Font')
|
||||
- [WindowPosition](#P-DesktopMagicPluginAPI-IPluginData-WindowPosition 'DesktopMagicPluginAPI.IPluginData.WindowPosition')
|
||||
- [WindowSize](#P-DesktopMagicPluginAPI-IPluginData-WindowSize 'DesktopMagicPluginAPI.IPluginData.WindowSize')
|
||||
- [UpdateWindow()](#M-DesktopMagicPluginAPI-IPluginData-UpdateWindow 'DesktopMagicPluginAPI.IPluginData.UpdateWindow')
|
||||
- [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown')
|
||||
- [#ctor(min,max,value)](#M-DesktopMagicPluginAPI-Inputs-IntegerUpDown-#ctor-System-Int32,System-Int32,System-Int32- 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.#ctor(System.Int32,System.Int32,System.Int32)')
|
||||
- [Maximum](#P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Maximum 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.Maximum')
|
||||
- [Minimum](#P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Minimum 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.Minimum')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Value 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.Value')
|
||||
- [Label](#T-DesktopMagicPluginAPI-Inputs-Label 'DesktopMagicPluginAPI.Inputs.Label')
|
||||
- [#ctor(value,bold)](#M-DesktopMagicPluginAPI-Inputs-Label-#ctor-System-String,System-Boolean- 'DesktopMagicPluginAPI.Inputs.Label.#ctor(System.String,System.Boolean)')
|
||||
- [Bold](#P-DesktopMagicPluginAPI-Inputs-Label-Bold 'DesktopMagicPluginAPI.Inputs.Label.Bold')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-Label-Value 'DesktopMagicPluginAPI.Inputs.Label.Value')
|
||||
- [Plugin](#T-DesktopMagicPluginAPI-Plugin 'DesktopMagicPluginAPI.Plugin')
|
||||
- [Application](#P-DesktopMagicPluginAPI-Plugin-Application 'DesktopMagicPluginAPI.Plugin.Application')
|
||||
- [UpdateInterval](#P-DesktopMagicPluginAPI-Plugin-UpdateInterval 'DesktopMagicPluginAPI.Plugin.UpdateInterval')
|
||||
- [Main()](#M-DesktopMagicPluginAPI-Plugin-Main 'DesktopMagicPluginAPI.Plugin.Main')
|
||||
- [OnMouseClick(position)](#M-DesktopMagicPluginAPI-Plugin-OnMouseClick-System-Drawing-Point- 'DesktopMagicPluginAPI.Plugin.OnMouseClick(System.Drawing.Point)')
|
||||
- [OnMouseMove(position)](#M-DesktopMagicPluginAPI-Plugin-OnMouseMove-System-Drawing-Point- 'DesktopMagicPluginAPI.Plugin.OnMouseMove(System.Drawing.Point)')
|
||||
- [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider')
|
||||
- [#ctor(min,max,value)](#M-DesktopMagicPluginAPI-Inputs-Slider-#ctor-System-Double,System-Double,System-Double- 'DesktopMagicPluginAPI.Inputs.Slider.#ctor(System.Double,System.Double,System.Double)')
|
||||
- [Maximum](#P-DesktopMagicPluginAPI-Inputs-Slider-Maximum 'DesktopMagicPluginAPI.Inputs.Slider.Maximum')
|
||||
- [Minimum](#P-DesktopMagicPluginAPI-Inputs-Slider-Minimum 'DesktopMagicPluginAPI.Inputs.Slider.Minimum')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-Slider-Value 'DesktopMagicPluginAPI.Inputs.Slider.Value')
|
||||
- [TextBox](#T-DesktopMagicPluginAPI-Inputs-TextBox 'DesktopMagicPluginAPI.Inputs.TextBox')
|
||||
- [#ctor(value)](#M-DesktopMagicPluginAPI-Inputs-TextBox-#ctor-System-String- 'DesktopMagicPluginAPI.Inputs.TextBox.#ctor(System.String)')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-TextBox-Value 'DesktopMagicPluginAPI.Inputs.TextBox.Value')
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Button'></a>
|
||||
## Button `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a button control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Button-#ctor-System-String-'></a>
|
||||
### #ctor(value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The text caption displayed in the [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button') control. |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Button-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the text caption displayed in the [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button') element.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Button-Click'></a>
|
||||
### Click() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Triggers the [](#E-DesktopMagicPluginAPI-Inputs-Button-OnClick 'DesktopMagicPluginAPI.Inputs.Button.OnClick') event.
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-CheckBox'></a>
|
||||
## CheckBox `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a check box control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-CheckBox-#ctor-System-Boolean-'></a>
|
||||
### #ctor(value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | A value indicating whether the [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox') is in the checked state. |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-CheckBox-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or set a value indicating whether the [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox') is in the checked state.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Element'></a>
|
||||
## Element `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
The element base class
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Element-ValueChanged'></a>
|
||||
### ValueChanged() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Triggers the [](#E-DesktopMagicPluginAPI-Inputs-Element-OnValueChanged 'DesktopMagicPluginAPI.Inputs.Element.OnValueChanged') event
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-ElementAttribute'></a>
|
||||
## ElementAttribute `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Marks a Property as element.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-String,System-Int32-'></a>
|
||||
### #ctor(name,orderIndex) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Marks a Property as element with the provided `name` and `orderIndex`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| name | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The name of the element. |
|
||||
| orderIndex | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The order index of the element. |
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-Int32-'></a>
|
||||
### #ctor(orderIndex) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Marks a Property as element with the provided `orderIndex`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| orderIndex | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The order index of the element. |
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor'></a>
|
||||
### #ctor() `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
*Inherit from parent.*
|
||||
|
||||
##### Parameters
|
||||
|
||||
This constructor has no parameters.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-ElementAttribute-Name'></a>
|
||||
### Name `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
The name of the element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-ElementAttribute-OrderIndex'></a>
|
||||
### OrderIndex `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
The order index of the element.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-IPluginData'></a>
|
||||
## IPluginData `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI
|
||||
|
||||
##### Summary
|
||||
|
||||
Defines properties and methods that provide information about the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-Color'></a>
|
||||
### Color `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the color of the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-Font'></a>
|
||||
### Font `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the font of the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-WindowPosition'></a>
|
||||
### WindowPosition `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the window position of the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-WindowSize'></a>
|
||||
### WindowSize `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the window size of the main application.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-IPluginData-UpdateWindow'></a>
|
||||
### UpdateWindow() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Updates the plugin window
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-IntegerUpDown'></a>
|
||||
## IntegerUpDown `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a up-down control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-IntegerUpDown-#ctor-System-Int32,System-Int32,System-Int32-'></a>
|
||||
### #ctor(min,max,value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') class with the provided `min` value, `max` value and `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| min | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The maximum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element. |
|
||||
| max | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The minimum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element. |
|
||||
| value | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The value assigned to the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element. |
|
||||
|
||||
##### Exceptions
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| [System.ArgumentException](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.ArgumentException 'System.ArgumentException') | |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Maximum'></a>
|
||||
### Maximum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the maximum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Minimum'></a>
|
||||
### Minimum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the minimum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the value assigned to the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Label'></a>
|
||||
## Label `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a label control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Label-#ctor-System-String,System-Boolean-'></a>
|
||||
### #ctor(value,bold) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [Label](#T-DesktopMagicPluginAPI-Inputs-Label 'DesktopMagicPluginAPI.Inputs.Label') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | |
|
||||
| bold | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Label-Bold'></a>
|
||||
### Bold `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or set a value indicating whether the content of the [Label](#T-DesktopMagicPluginAPI-Inputs-Label 'DesktopMagicPluginAPI.Inputs.Label') is bold or not.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Label-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the text associated with this control.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Plugin'></a>
|
||||
## Plugin `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI
|
||||
|
||||
##### Summary
|
||||
|
||||
The plugin class
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Plugin-Application'></a>
|
||||
### Application `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Informations about the main application
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Plugin-UpdateInterval'></a>
|
||||
### UpdateInterval `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the interval, expressed in milliseconds, at which to call the [Main](#M-DesktopMagicPluginAPI-Plugin-Main 'DesktopMagicPluginAPI.Plugin.Main') method.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Plugin-Main'></a>
|
||||
### Main() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Occurs when the [UpdateInterval](#P-DesktopMagicPluginAPI-Plugin-UpdateInterval 'DesktopMagicPluginAPI.Plugin.UpdateInterval') elapses.
|
||||
|
||||
##### Returns
|
||||
|
||||
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Plugin-OnMouseClick-System-Drawing-Point-'></a>
|
||||
### OnMouseClick(position) `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Occurs when the window is clicked by the mouse.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| position | [System.Drawing.Point](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Drawing.Point 'System.Drawing.Point') | |
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Plugin-OnMouseMove-System-Drawing-Point-'></a>
|
||||
### OnMouseMove(position) `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Occurs when the mouse pointer is moved over the control.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| position | [System.Drawing.Point](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Drawing.Point 'System.Drawing.Point') | |
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Slider'></a>
|
||||
## Slider `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a slider control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Slider-#ctor-System-Double,System-Double,System-Double-'></a>
|
||||
### #ctor(min,max,value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') class with the provided `min` value, `max` value and `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| min | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | The maximum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element. |
|
||||
| max | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | The minimum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element. |
|
||||
| value | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | The value assigned to the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element. |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Slider-Maximum'></a>
|
||||
### Maximum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the maximum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Slider-Minimum'></a>
|
||||
### Minimum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the minimum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Slider-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the value assigned to the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-TextBox'></a>
|
||||
## TextBox `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a text box control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-TextBox-#ctor-System-String-'></a>
|
||||
### #ctor(value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [TextBox](#T-DesktopMagicPluginAPI-Inputs-TextBox 'DesktopMagicPluginAPI.Inputs.TextBox') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-TextBox-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the text associated with this control.
|
||||
Reference in New Issue
Block a user