2025-07-18 15:38:28 +08:00

669 lines
18 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class PanelModel | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PanelModel | HiAPI-C# 2025 ">
<meta name="description" content="A panel model contains necessary data for manipulating a panel. It is platform-neutral.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.PanelModels.PanelModel">
<h1 id="Hi_PanelModels_PanelModel" data-uid="Hi.PanelModels.PanelModel" class="text-break">
Class PanelModel
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.PanelModels.html">PanelModels</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiDisp.dll</dd></dl>
</div>
<div class="markdown summary"><p>A panel model contains necessary data for manipulating a panel.
It is platform-neutral.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PanelModel</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">PanelModel</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_PanelModels_PanelModel_CursorDelta_" data-uid="Hi.PanelModels.PanelModel.CursorDelta*"></a>
<h3 id="Hi_PanelModels_PanelModel_CursorDelta" data-uid="Hi.PanelModels.PanelModel.CursorDelta">
CursorDelta
</h3>
<div class="markdown level1 summary"><p>Mouse cursor position changed from the last time to current.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vec2d CursorDelta { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Vec2d.html">Vec2d</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_PanelModel_CursorPosition_" data-uid="Hi.PanelModels.PanelModel.CursorPosition*"></a>
<h3 id="Hi_PanelModels_PanelModel_CursorPosition" data-uid="Hi.PanelModels.PanelModel.CursorPosition">
CursorPosition
</h3>
<div class="markdown level1 summary"><p>Current mouse cursor position.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vec2d CursorPosition { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Vec2d.html">Vec2d</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_PanelModel_Height_" data-uid="Hi.PanelModels.PanelModel.Height*"></a>
<h3 id="Hi_PanelModels_PanelModel_Height" data-uid="Hi.PanelModels.PanelModel.Height">
Height
</h3>
<div class="markdown level1 summary"><p>Panel height.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double Height { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_PanelModel_IsVisible_" data-uid="Hi.PanelModels.PanelModel.IsVisible*"></a>
<h3 id="Hi_PanelModels_PanelModel_IsVisible" data-uid="Hi.PanelModels.PanelModel.IsVisible">
IsVisible
</h3>
<div class="markdown level1 summary"><p>Is panel visible.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsVisible { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_PanelModel_ModifierKeys_" data-uid="Hi.PanelModels.PanelModel.ModifierKeys*"></a>
<h3 id="Hi_PanelModels_PanelModel_ModifierKeys" data-uid="Hi.PanelModels.PanelModel.ModifierKeys">
ModifierKeys
</h3>
<div class="markdown level1 summary"><p>Current pressed keyboard modifiers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HiModifierKeys ModifierKeys { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.PanelModels.HiModifierKeys.html">HiModifierKeys</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_PanelModel_MouseButtonMask_" data-uid="Hi.PanelModels.PanelModel.MouseButtonMask*"></a>
<h3 id="Hi_PanelModels_PanelModel_MouseButtonMask" data-uid="Hi.PanelModels.PanelModel.MouseButtonMask">
MouseButtonMask
</h3>
<div class="markdown level1 summary"><p>Current pressed mouse button.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HiMouseButtonMask MouseButtonMask { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_PanelModel_Width_" data-uid="Hi.PanelModels.PanelModel.Width*"></a>
<h3 id="Hi_PanelModels_PanelModel_Width" data-uid="Hi.PanelModels.PanelModel.Width">
Width
</h3>
<div class="markdown level1 summary"><p>Panel width.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double Width { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_PanelModels_PanelModel_KeyDown_" data-uid="Hi.PanelModels.PanelModel.KeyDown*"></a>
<h3 id="Hi_PanelModels_PanelModel_KeyDown_Hi_PanelModels_HiKey_" data-uid="Hi.PanelModels.PanelModel.KeyDown(Hi.PanelModels.HiKey)">
KeyDown(HiKey)
</h3>
<div class="markdown level1 summary"><p>Press the key to this model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void KeyDown(HiKey key)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="Hi.PanelModels.HiKey.html">HiKey</a></dt>
<dd><p>key</p>
</dd>
</dl>
<a id="Hi_PanelModels_PanelModel_KeyUp_" data-uid="Hi.PanelModels.PanelModel.KeyUp*"></a>
<h3 id="Hi_PanelModels_PanelModel_KeyUp_Hi_PanelModels_HiKey_" data-uid="Hi.PanelModels.PanelModel.KeyUp(Hi.PanelModels.HiKey)">
KeyUp(HiKey)
</h3>
<div class="markdown level1 summary"><p>Release the key to this model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void KeyUp(HiKey key)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="Hi.PanelModels.HiKey.html">HiKey</a></dt>
<dd><p>key</p>
</dd>
</dl>
<a id="Hi_PanelModels_PanelModel_MouseButtonDown_" data-uid="Hi.PanelModels.PanelModel.MouseButtonDown*"></a>
<h3 id="Hi_PanelModels_PanelModel_MouseButtonDown_Hi_PanelModels_HiMouseButton_" data-uid="Hi.PanelModels.PanelModel.MouseButtonDown(Hi.PanelModels.HiMouseButton)">
MouseButtonDown(HiMouseButton)
</h3>
<div class="markdown level1 summary"><p>Press the mouse button to this model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void MouseButtonDown(HiMouseButton button)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>button</code> <a class="xref" href="Hi.PanelModels.HiMouseButton.html">HiMouseButton</a></dt>
<dd><p>button</p>
</dd>
</dl>
<a id="Hi_PanelModels_PanelModel_MouseButtonUp_" data-uid="Hi.PanelModels.PanelModel.MouseButtonUp*"></a>
<h3 id="Hi_PanelModels_PanelModel_MouseButtonUp_Hi_PanelModels_HiMouseButton_" data-uid="Hi.PanelModels.PanelModel.MouseButtonUp(Hi.PanelModels.HiMouseButton)">
MouseButtonUp(HiMouseButton)
</h3>
<div class="markdown level1 summary"><p>Release the mouse button to this model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void MouseButtonUp(HiMouseButton button)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>button</code> <a class="xref" href="Hi.PanelModels.HiMouseButton.html">HiMouseButton</a></dt>
<dd><p>button</p>
</dd>
</dl>
<a id="Hi_PanelModels_PanelModel_MouseMove_" data-uid="Hi.PanelModels.PanelModel.MouseMove*"></a>
<h3 id="Hi_PanelModels_PanelModel_MouseMove_Hi_Geom_Vec2d_" data-uid="Hi.PanelModels.PanelModel.MouseMove(Hi.Geom.Vec2d)">
MouseMove(Vec2d)
</h3>
<div class="markdown level1 summary"><p>Move the mouse and update the mouse cursor position to this model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void MouseMove(Vec2d cursorPosition)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>cursorPosition</code> <a class="xref" href="Hi.Geom.Vec2d.html">Vec2d</a></dt>
<dd><p>cursor position</p>
</dd>
</dl>
<a id="Hi_PanelModels_PanelModel_MouseWheel_" data-uid="Hi.PanelModels.PanelModel.MouseWheel*"></a>
<h3 id="Hi_PanelModels_PanelModel_MouseWheel_System_Int32_" data-uid="Hi.PanelModels.PanelModel.MouseWheel(System.Int32)">
MouseWheel(int)
</h3>
<div class="markdown level1 summary"><p>Roll mouse wheel to this model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void MouseWheel(int delta)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>delta</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>the quantity of the mouse wheel rolling</p>
</dd>
</dl>
<a id="Hi_PanelModels_PanelModel_Resize_" data-uid="Hi.PanelModels.PanelModel.Resize*"></a>
<h3 id="Hi_PanelModels_PanelModel_Resize_System_Double_System_Double_" data-uid="Hi.PanelModels.PanelModel.Resize(System.Double,System.Double)">
Resize(double, double)
</h3>
<div class="markdown level1 summary"><p>Resize the panel model.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Resize(double w, double h)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>w</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>width</p>
</dd>
<dt><code>h</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>height</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>