blob: 18e12a1574cc51960371bf7302ba455d530ae3e4 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class PointerInputDevice.PointerEventProperties </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PointerInputDevice.PointerEventProperties ">
<meta name="description" content="A class representing the properties of a pointer event.">
<link rel="icon" href="../images/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="docfx:docurl" content="https://github.com/SeleniumHQ/selenium/new/trunk/apiSpec/new?filename=OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<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="../images/logo.svg" alt="Selenium .NET API">
Selenium .NET API
</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="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties">
<h1 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties" class="text-break">
Class PointerInputDevice.PointerEventProperties <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L291"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="OpenQA.html">OpenQA</a>.<a class="xref" href="OpenQA.Selenium.html">Selenium</a>.<a class="xref" href="OpenQA.Selenium.Interactions.html">Interactions</a></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>A class representing the properties of a pointer event.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PointerInputDevice.PointerEventProperties</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">PointerInputDevice.PointerEventProperties</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="properties">Properties
</h2>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_AltitudeAngle_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.AltitudeAngle*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_AltitudeAngle" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.AltitudeAngle">
AltitudeAngle
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L353"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the altitude in radians of the transducer (e.g. pen/stylus)</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double? AltitudeAngle { 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>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_AltitudeAngle_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Valid values are between 0 and π/2, where 0 is parallel to the surface (X-Y plane),
and π/2 is perpendicular to the surface.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_AzimuthAngle_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.AzimuthAngle*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_AzimuthAngle" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.AzimuthAngle">
AzimuthAngle
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L363"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the azimuth angle (in radians) of the transducer (e.g. pen/stylus)</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double? AzimuthAngle { 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>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_AzimuthAngle_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Valid values are between 0 and 2Ï€,
where 0 represents a transducer whose cap is pointing in the direction of increasing X values,
and the values progressively increase when going clockwise.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Height_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Height*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Height" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Height">
Height
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L301"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the height (magnitude on y-axis) in pixels of the contact geometry of the pointer.</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="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Pressure_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Pressure*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Pressure" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Pressure">
Pressure
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L309"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the normalized pressure of the pointer input.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double? Pressure { 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>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Pressure_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TangentialPressure_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.TangentialPressure*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TangentialPressure" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.TangentialPressure">
TangentialPressure
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L318"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the normalized tangential pressure (also known as barrel pressure) of the pointer input.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double? TangentialPressure { 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>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TangentialPressure_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Valid values are between -1 and 1 with 0 being the neutral position of the control.
Some hardware may only support positive values between 0 and 1.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TiltX_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.TiltX*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TiltX" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.TiltX">
TiltX
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L327"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the plane angle in degrees between the Y-Z plane and the plane containing
both the transducer (e.g. pen stylus) axis and the Y axis..</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? TiltX { 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.int32">int</a>?</dt>
<dd></dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TiltX_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Valid values are between -90 and 90. A positive value is to the right.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TiltY_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.TiltY*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TiltY" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.TiltY">
TiltY
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L336"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the plane angle in degrees between the X-Z plane and the plane containing
both the transducer (e.g. pen stylus) axis and the X axis..</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? TiltY { 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.int32">int</a>?</dt>
<dd></dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_TiltY_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Valid values are between -90 and 90. A positive value is toward the user.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Twist_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Twist*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Twist" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Twist">
Twist
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L344"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the clockwise rotation in degrees of a transducer (e.g. stylus) around its own major axis</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? Twist { 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.int32">int</a>?</dt>
<dd></dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Twist_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Valid values are between 0 and 359.</p>
</div>
<a id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Width_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Width*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_Width" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.Width">
Width
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L296"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the width (magnitude on x-axis) in pixels of the contact geometry of the pointer.</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="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_ToDictionary_" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.ToDictionary*"></a>
<h3 id="OpenQA_Selenium_Interactions_PointerInputDevice_PointerEventProperties_ToDictionary" data-uid="OpenQA.Selenium.Interactions.PointerInputDevice.PointerEventProperties.ToDictionary">
ToDictionary()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L369"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Serializes the properties of this input device as a dictionary.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, object&gt; ToDictionary()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd><p>The dictionary containing the properties of this device.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/PointerInputDevice.cs/#L291" class="edit-link">Edit this page</a>
</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>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>