HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.PanelModels.HiMouseButtonMaskUtil.html
2025-07-18 15:38:28 +08:00

575 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class HiMouseButtonMaskUtil | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class HiMouseButtonMaskUtil | HiAPI-C# 2025 ">
<meta name="description" content="Utility of .">
<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.HiMouseButtonMaskUtil">
<h1 id="Hi_PanelModels_HiMouseButtonMaskUtil" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil" class="text-break">
Class HiMouseButtonMaskUtil
</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>Utility of <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a>.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class HiMouseButtonMaskUtil</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">HiMouseButtonMaskUtil</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>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_PanelModels_HiMouseButtonMaskUtil_IsLeftPressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsLeftPressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_IsLeftPressed_Hi_PanelModels_HiMouseButtonMask_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsLeftPressed(Hi.PanelModels.HiMouseButtonMask)">
IsLeftPressed(HiMouseButtonMask)
</h3>
<div class="markdown level1 summary"><p>Is mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_Left">Left</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsLeftPressed(this HiMouseButtonMask src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_HiMouseButtonMaskUtil_IsMiddlePressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsMiddlePressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_IsMiddlePressed_Hi_PanelModels_HiMouseButtonMask_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsMiddlePressed(Hi.PanelModels.HiMouseButtonMask)">
IsMiddlePressed(HiMouseButtonMask)
</h3>
<div class="markdown level1 summary"><p>Is mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_Middle">Middle</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsMiddlePressed(this HiMouseButtonMask src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_HiMouseButtonMaskUtil_IsRightPressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsRightPressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_IsRightPressed_Hi_PanelModels_HiMouseButtonMask_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsRightPressed(Hi.PanelModels.HiMouseButtonMask)">
IsRightPressed(HiMouseButtonMask)
</h3>
<div class="markdown level1 summary"><p>Is mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_Right">Right</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsRightPressed(this HiMouseButtonMask src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_HiMouseButtonMaskUtil_IsXButton1Pressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsXButton1Pressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_IsXButton1Pressed_Hi_PanelModels_HiMouseButtonMask_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsXButton1Pressed(Hi.PanelModels.HiMouseButtonMask)">
IsXButton1Pressed(HiMouseButtonMask)
</h3>
<div class="markdown level1 summary"><p>Is mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_XButton1">XButton1</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsXButton1Pressed(this HiMouseButtonMask src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_HiMouseButtonMaskUtil_IsXButton2Pressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsXButton2Pressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_IsXButton2Pressed_Hi_PanelModels_HiMouseButtonMask_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.IsXButton2Pressed(Hi.PanelModels.HiMouseButtonMask)">
IsXButton2Pressed(HiMouseButtonMask)
</h3>
<div class="markdown level1 summary"><p>Is mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_XButton2">XButton2</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool IsXButton2Pressed(this HiMouseButtonMask src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</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_HiMouseButtonMaskUtil_Set_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.Set*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_Set_Hi_PanelModels_HiMouseButtonMask__Hi_PanelModels_HiMouseButton_System_Boolean_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.Set(Hi.PanelModels.HiMouseButtonMask@,Hi.PanelModels.HiMouseButton,System.Boolean)">
Set(ref HiMouseButtonMask, HiMouseButton, bool)
</h3>
<div class="markdown level1 summary"><p>Set the src by <a class="xref" href="Hi.PanelModels.HiMouseButton.html">HiMouseButton</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Set(this ref HiMouseButtonMask src, HiMouseButton changedMouseButton, bool isPressed)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd><p>src</p>
</dd>
<dt><code>changedMouseButton</code> <a class="xref" href="Hi.PanelModels.HiMouseButton.html">HiMouseButton</a></dt>
<dd><p>changed mouse button</p>
</dd>
<dt><code>isPressed</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>true if the action is pressed; false if the action is released</p>
</dd>
</dl>
<a id="Hi_PanelModels_HiMouseButtonMaskUtil_SetLeftPressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetLeftPressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_SetLeftPressed_Hi_PanelModels_HiMouseButtonMask__System_Boolean_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetLeftPressed(Hi.PanelModels.HiMouseButtonMask@,System.Boolean)">
SetLeftPressed(ref HiMouseButtonMask, bool)
</h3>
<div class="markdown level1 summary"><p>Set mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_Left">Left</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SetLeftPressed(this ref HiMouseButtonMask src, bool b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_HiMouseButtonMaskUtil_SetMiddlePressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetMiddlePressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_SetMiddlePressed_Hi_PanelModels_HiMouseButtonMask__System_Boolean_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetMiddlePressed(Hi.PanelModels.HiMouseButtonMask@,System.Boolean)">
SetMiddlePressed(ref HiMouseButtonMask, bool)
</h3>
<div class="markdown level1 summary"><p>Set mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_Middle">Middle</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SetMiddlePressed(this ref HiMouseButtonMask src, bool b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_HiMouseButtonMaskUtil_SetRightPressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetRightPressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_SetRightPressed_Hi_PanelModels_HiMouseButtonMask__System_Boolean_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetRightPressed(Hi.PanelModels.HiMouseButtonMask@,System.Boolean)">
SetRightPressed(ref HiMouseButtonMask, bool)
</h3>
<div class="markdown level1 summary"><p>Set mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_Right">Right</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SetRightPressed(this ref HiMouseButtonMask src, bool b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_HiMouseButtonMaskUtil_SetXButton1Pressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetXButton1Pressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_SetXButton1Pressed_Hi_PanelModels_HiMouseButtonMask__System_Boolean_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetXButton1Pressed(Hi.PanelModels.HiMouseButtonMask@,System.Boolean)">
SetXButton1Pressed(ref HiMouseButtonMask, bool)
</h3>
<div class="markdown level1 summary"><p>Set mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_XButton1">XButton1</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SetXButton1Pressed(this ref HiMouseButtonMask src, bool b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_PanelModels_HiMouseButtonMaskUtil_SetXButton2Pressed_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetXButton2Pressed*"></a>
<h3 id="Hi_PanelModels_HiMouseButtonMaskUtil_SetXButton2Pressed_Hi_PanelModels_HiMouseButtonMask__System_Boolean_" data-uid="Hi.PanelModels.HiMouseButtonMaskUtil.SetXButton2Pressed(Hi.PanelModels.HiMouseButtonMask@,System.Boolean)">
SetXButton2Pressed(ref HiMouseButtonMask, bool)
</h3>
<div class="markdown level1 summary"><p>Set mouse button <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html#Hi_PanelModels_HiMouseButtonMask_XButton2">XButton2</a> pressed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SetXButton2Pressed(this ref HiMouseButtonMask src, bool b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.PanelModels.HiMouseButtonMask.html">HiMouseButtonMask</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></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>