Stone_Red/DesktopMagic
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/DesktopMagic.git synced 2026-09-05 07:46:15 +02:00
Code Issues Packages Projects Releases 10 Wiki Activity
Files
441a8b00cc49c067e72bc80a9c90f274b7956e9b
DesktopMagic/_src/DesktopMagicPluginAPI/_site/api/DesktopMagicPluginAPI.IPluginData.html
T
Stone_Red 441a8b00cc - Rename src to _src
2021-12-23 11:11:06 +01:00

367 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IPluginData
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IPluginData
">
<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.IPluginData">
<h1 id="DesktopMagicPluginAPI_IPluginData" data-uid="DesktopMagicPluginAPI.IPluginData" class="text-break">Interface IPluginData
</h1>
<div class="markdown level0 summary"><p>Defines properties and methods that provide information about the main application.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="DesktopMagicPluginAPI.html">DesktopMagicPluginAPI</a></h6>
<h6><strong>Assembly</strong>: DesktopMagicPluginAPI.dll</h6>
<h5 id="DesktopMagicPluginAPI_IPluginData_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IPluginData</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_IPluginData_Color.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.Color%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/IPluginData.cs/#L20">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_Color_" data-uid="DesktopMagicPluginAPI.IPluginData.Color*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_Color" data-uid="DesktopMagicPluginAPI.IPluginData.Color">Color</h4>
<div class="markdown level1 summary"><p>Gets the current color of the current theme.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use the \&quot;Theme\&quot; property instead&quot;)]
Color Color { get; }</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.Drawing.Color</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_IPluginData_Font.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.Font%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/IPluginData.cs/#L14">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_Font_" data-uid="DesktopMagicPluginAPI.IPluginData.Font*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_Font" data-uid="DesktopMagicPluginAPI.IPluginData.Font">Font</h4>
<div class="markdown level1 summary"><p>Gets the current font of the current theme.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use the \&quot;Theme\&quot; property instead&quot;)]
string Font { get; }</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.String</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_IPluginData_PluginName.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.PluginName%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/IPluginData.cs/#L41">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_PluginName_" data-uid="DesktopMagicPluginAPI.IPluginData.PluginName*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_PluginName" data-uid="DesktopMagicPluginAPI.IPluginData.PluginName">PluginName</h4>
<div class="markdown level1 summary"><p>Gets the name of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">string PluginName { get; }</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.String</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_IPluginData_PluginPath.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.PluginPath%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/IPluginData.cs/#L46">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_PluginPath_" data-uid="DesktopMagicPluginAPI.IPluginData.PluginPath*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_PluginPath" data-uid="DesktopMagicPluginAPI.IPluginData.PluginPath">PluginPath</h4>
<div class="markdown level1 summary"><p>Gets the path of the parent directory of the plugin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">string PluginPath { get; }</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.String</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_IPluginData_Theme.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.Theme%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/IPluginData.cs/#L26">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_Theme_" data-uid="DesktopMagicPluginAPI.IPluginData.Theme*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_Theme" data-uid="DesktopMagicPluginAPI.IPluginData.Theme">Theme</h4>
<div class="markdown level1 summary"><p>Gets the current theme setting of 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">ITheme Theme { get; }</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.ITheme.html">ITheme</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_IPluginData_WindowPosition.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.WindowPosition%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/IPluginData.cs/#L36">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_WindowPosition_" data-uid="DesktopMagicPluginAPI.IPluginData.WindowPosition*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_WindowPosition" data-uid="DesktopMagicPluginAPI.IPluginData.WindowPosition">WindowPosition</h4>
<div class="markdown level1 summary"><p>Gets the window position of the plugin window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Point WindowPosition { get; }</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.Drawing.Point</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_IPluginData_WindowSize.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.WindowSize%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/IPluginData.cs/#L31">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_WindowSize_" data-uid="DesktopMagicPluginAPI.IPluginData.WindowSize*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_WindowSize" data-uid="DesktopMagicPluginAPI.IPluginData.WindowSize">WindowSize</h4>
<div class="markdown level1 summary"><p>Gets the window size of the plugin window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Size WindowSize { get; }</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.Drawing.Size</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_IPluginData_UpdateWindow.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData.UpdateWindow%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/IPluginData.cs/#L51">View Source</a>
</span>
<a id="DesktopMagicPluginAPI_IPluginData_UpdateWindow_" data-uid="DesktopMagicPluginAPI.IPluginData.UpdateWindow*"></a>
<h4 id="DesktopMagicPluginAPI_IPluginData_UpdateWindow" data-uid="DesktopMagicPluginAPI.IPluginData.UpdateWindow">UpdateWindow()</h4>
<div class="markdown level1 summary"><p>Updates the plugin window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void UpdateWindow()</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_IPluginData.md&amp;value=---%0Auid%3A%20DesktopMagicPluginAPI.IPluginData%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/IPluginData.cs/#L9" 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>
Reference in New Issue View Git Blame Copy Permalink