mirror of
https://github.com/Stone-Red-Code/DesktopMagic.git
synced 2026-09-07 07:46:12 +02:00
431 lines
21 KiB
HTML
431 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class Plugin
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class Plugin
|
|
">
|
|
<meta name="generator" content="docfx 2.58.9.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="DesktopMagicPluginAPI.Plugin">
|
|
|
|
|
|
<h1 id="DesktopMagicPluginAPI_Plugin" data-uid="DesktopMagicPluginAPI.Plugin" class="text-break">Class Plugin
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>The plugin class.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">Plugin</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="DesktopMagicPluginAPI.html">DesktopMagicPluginAPI</a></h6>
|
|
<h6><strong>Assembly</strong>: DesktopMagicPluginAPI.dll</h6>
|
|
<h5 id="DesktopMagicPluginAPI_Plugin_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract class Plugin</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_Application.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.Application%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L19">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_Application_" data-uid="DesktopMagicPluginAPI.Plugin.Application*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_Application" data-uid="DesktopMagicPluginAPI.Plugin.Application">Application</h4>
|
|
<div class="markdown level1 summary"><p>Informations about the main application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IPluginData Application { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="DesktopMagicPluginAPI.IPluginData.html">IPluginData</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_RenderQuality.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.RenderQuality%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_RenderQuality_" data-uid="DesktopMagicPluginAPI.Plugin.RenderQuality*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_RenderQuality" data-uid="DesktopMagicPluginAPI.Plugin.RenderQuality">RenderQuality</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the render quality of the bitmap image.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual RenderQuality RenderQuality { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="DesktopMagicPluginAPI.Drawing.RenderQuality.html">RenderQuality</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_UpdateInterval.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.UpdateInterval%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L28">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_UpdateInterval_" data-uid="DesktopMagicPluginAPI.Plugin.UpdateInterval*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_UpdateInterval" data-uid="DesktopMagicPluginAPI.Plugin.UpdateInterval">UpdateInterval</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the interval, expressed in milliseconds, at which to call the <a class="xref" href="DesktopMagicPluginAPI.Plugin.html#DesktopMagicPluginAPI_Plugin_Main">Main()</a> method.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual int UpdateInterval { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_Main.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.Main%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L53">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_Main_" data-uid="DesktopMagicPluginAPI.Plugin.Main*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_Main" data-uid="DesktopMagicPluginAPI.Plugin.Main">Main()</h4>
|
|
<div class="markdown level1 summary"><p>Occurs when the <a class="xref" href="DesktopMagicPluginAPI.Plugin.html#DesktopMagicPluginAPI_Plugin_UpdateInterval">UpdateInterval</a> elapses.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract Bitmap Main()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Drawing.Bitmap</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_OnMouseClick_System_Drawing_Point_DesktopMagicPluginAPI_Inputs_MouseButton_.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.OnMouseClick(System.Drawing.Point%2CDesktopMagicPluginAPI.Inputs.MouseButton)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L60">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_OnMouseClick_" data-uid="DesktopMagicPluginAPI.Plugin.OnMouseClick*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_OnMouseClick_System_Drawing_Point_DesktopMagicPluginAPI_Inputs_MouseButton_" data-uid="DesktopMagicPluginAPI.Plugin.OnMouseClick(System.Drawing.Point,DesktopMagicPluginAPI.Inputs.MouseButton)">OnMouseClick(Point, MouseButton)</h4>
|
|
<div class="markdown level1 summary"><p>Occurs when the window is clicked by the mouse.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void OnMouseClick(Point position, MouseButton mouseButton)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Drawing.Point</span></td>
|
|
<td><span class="parametername">position</span></td>
|
|
<td><p>The x- and y-coordinates of the mouse pointer position relative to the plugin window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="DesktopMagicPluginAPI.Inputs.MouseButton.html">MouseButton</a></td>
|
|
<td><span class="parametername">mouseButton</span></td>
|
|
<td><p>The button associated with the event.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_OnMouseMove_System_Drawing_Point_.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.OnMouseMove(System.Drawing.Point)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L68">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_OnMouseMove_" data-uid="DesktopMagicPluginAPI.Plugin.OnMouseMove*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_OnMouseMove_System_Drawing_Point_" data-uid="DesktopMagicPluginAPI.Plugin.OnMouseMove(System.Drawing.Point)">OnMouseMove(Point)</h4>
|
|
<div class="markdown level1 summary"><p>Occurs when the mouse pointer is moved over the control.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void OnMouseMove(Point position)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Drawing.Point</span></td>
|
|
<td><span class="parametername">position</span></td>
|
|
<td><p>The x- and y-coordinates of the mouse pointer position relative to the plugin window.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_OnMouseWheel_System_Drawing_Point_System_Int32_.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.OnMouseWheel(System.Drawing.Point%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L77">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_OnMouseWheel_" data-uid="DesktopMagicPluginAPI.Plugin.OnMouseWheel*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_OnMouseWheel_System_Drawing_Point_System_Int32_" data-uid="DesktopMagicPluginAPI.Plugin.OnMouseWheel(System.Drawing.Point,System.Int32)">OnMouseWheel(Point, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Occurs when the user rotates the mouse wheel while the mouse pointer is over this element.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void OnMouseWheel(Point position, int delta)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Drawing.Point</span></td>
|
|
<td><span class="parametername">position</span></td>
|
|
<td><p>The x- and y-coordinates of the mouse pointer position relative to the plugin window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">delta</span></td>
|
|
<td><p>A value that indicates the amount that the mouse wheel has changed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_Start.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.Start%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L38">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_Start_" data-uid="DesktopMagicPluginAPI.Plugin.Start*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_Start" data-uid="DesktopMagicPluginAPI.Plugin.Start">Start()</h4>
|
|
<div class="markdown level1 summary"><p>Occurs once when the plugin gets activated.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void Start()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin_Stop.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin.Stop%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L45">View Source</a>
|
|
</span>
|
|
<a id="DesktopMagicPluginAPI_Plugin_Stop_" data-uid="DesktopMagicPluginAPI.Plugin.Stop*"></a>
|
|
<h4 id="DesktopMagicPluginAPI_Plugin_Stop" data-uid="DesktopMagicPluginAPI.Plugin.Stop">Stop()</h4>
|
|
<div class="markdown level1 summary"><p>Occurs once when the plugin gets deactivated.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual void Stop()</code></pre>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/new/develop/apiSpec/new?filename=DesktopMagicPluginAPI_Plugin.md&value=---%0Auid%3A%20DesktopMagicPluginAPI.Plugin%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/Stone-Red-Code/DesktopMagic/blob/develop/src/DesktopMagicPluginAPI/Plugin.cs/#L12" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|