blob: 5040e59ccce241e4b89b3231cdad86228442be73 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class WheelInputDevice </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class WheelInputDevice ">
<meta name="description" content="Represents a wheel input device, such as a mouse wheel.">
<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_WheelInputDevice.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.Interactions.WheelInputDevice%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.WheelInputDevice">
<h1 id="OpenQA_Selenium_Interactions_WheelInputDevice" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice" class="text-break">
Class WheelInputDevice <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L29"><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>Represents a wheel input device, such as a mouse wheel.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class WheelInputDevice : InputDevice</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><a class="xref" href="OpenQA.Selenium.Interactions.InputDevice.html">InputDevice</a></div>
<div><span class="xref">WheelInputDevice</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="OpenQA.Selenium.Interactions.InputDevice.html#OpenQA_Selenium_Interactions_InputDevice_DeviceName">InputDevice.DeviceName</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.Interactions.InputDevice.html#OpenQA_Selenium_Interactions_InputDevice_CreatePause">InputDevice.CreatePause()</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.Interactions.InputDevice.html#OpenQA_Selenium_Interactions_InputDevice_CreatePause_System_TimeSpan_">InputDevice.CreatePause(TimeSpan)</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.Interactions.InputDevice.html#OpenQA_Selenium_Interactions_InputDevice_GetHashCode">InputDevice.GetHashCode()</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.Interactions.InputDevice.html#OpenQA_Selenium_Interactions_InputDevice_ToString">InputDevice.ToString()</a>
</div>
<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.referenceequals">object.ReferenceEquals(object, object)</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>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice__ctor_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.#ctor*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice__ctor" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.#ctor">
WheelInputDevice()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L34"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="OpenQA.Selenium.Interactions.WheelInputDevice.html">WheelInputDevice</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public WheelInputDevice()</code></pre>
</div>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice__ctor_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.#ctor*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice__ctor_System_String_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.#ctor(System.String)">
WheelInputDevice(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L44"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="OpenQA.Selenium.Interactions.WheelInputDevice.html">WheelInputDevice</a> class, given the device's name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public WheelInputDevice(string deviceName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>deviceName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The unique name of this input device.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></dt>
<dd><p>If <code class="paramref">deviceName</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> or <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.empty">Empty</a>.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice_DeviceKind_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.DeviceKind*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice_DeviceKind" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.DeviceKind">
DeviceKind
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L52"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the type of device for this input device.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override InputDeviceKind DeviceKind { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Interactions.InputDeviceKind.html">InputDeviceKind</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice_CreateWheelScroll_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.CreateWheelScroll*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice_CreateWheelScroll_OpenQA_Selenium_IWebElement_System_Int32_System_Int32_System_Int32_System_Int32_System_TimeSpan_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.CreateWheelScroll(OpenQA.Selenium.IWebElement,System.Int32,System.Int32,System.Int32,System.Int32,System.TimeSpan)">
CreateWheelScroll(IWebElement, int, int, int, int, TimeSpan)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L91"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a wheel scroll action beginning with an element.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Interaction CreateWheelScroll(IWebElement target, int xOffset, int yOffset, int deltaX, int deltaY, TimeSpan duration)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>target</code> <a class="xref" href="OpenQA.Selenium.IWebElement.html">IWebElement</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.IWebElement.html">IWebElement</a> in which to begin the scroll.</p>
</dd>
<dt><code>xOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The horizontal offset from the center of the target element from which to start the scroll.</p>
</dd>
<dt><code>yOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The vertical offset from the center of the target element from which to start the scroll.</p>
</dd>
<dt><code>deltaX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The distance along the X axis to scroll using the wheel.</p>
</dd>
<dt><code>deltaY</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The distance along the Y axis to scroll using the wheel.</p>
</dd>
<dt><code>duration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd><p>The duration of the scroll action.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Interactions.Interaction.html">Interaction</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.Interactions.Interaction.html">Interaction</a> representing the wheel scroll.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
<dd><p>If <code class="paramref">target</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice_CreateWheelScroll_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.CreateWheelScroll*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice_CreateWheelScroll_OpenQA_Selenium_Interactions_CoordinateOrigin_System_Int32_System_Int32_System_Int32_System_Int32_System_TimeSpan_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.CreateWheelScroll(OpenQA.Selenium.Interactions.CoordinateOrigin,System.Int32,System.Int32,System.Int32,System.Int32,System.TimeSpan)">
CreateWheelScroll(CoordinateOrigin, int, int, int, int, TimeSpan)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L111"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a wheel scroll action.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Interaction CreateWheelScroll(CoordinateOrigin origin, int xOffset, int yOffset, int deltaX, int deltaY, TimeSpan duration)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>origin</code> <a class="xref" href="OpenQA.Selenium.Interactions.CoordinateOrigin.html">CoordinateOrigin</a></dt>
<dd><p>The coordinate origin, either the view port or the current pointer position, from which to begin the scroll.</p>
</dd>
<dt><code>xOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The horizontal offset from the center of the origin from which to start the scroll.</p>
</dd>
<dt><code>yOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The vertical offset from the center of the origin from which to start the scroll.</p>
</dd>
<dt><code>deltaX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The distance along the X axis to scroll using the wheel.</p>
</dd>
<dt><code>deltaY</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The distance along the Y axis to scroll using the wheel.</p>
</dd>
<dt><code>duration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd><p>The duration of the scroll action.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Interactions.Interaction.html">Interaction</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.Interactions.Interaction.html">Interaction</a> representing the wheel scroll.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice_CreateWheelScroll_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.CreateWheelScroll*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice_CreateWheelScroll_System_Int32_System_Int32_System_TimeSpan_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.CreateWheelScroll(System.Int32,System.Int32,System.TimeSpan)">
CreateWheelScroll(int, int, TimeSpan)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L75"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a wheel scroll action.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Interaction CreateWheelScroll(int deltaX, int deltaY, TimeSpan duration)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>deltaX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The distance along the X axis to scroll using the wheel.</p>
</dd>
<dt><code>deltaY</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The distance along the Y axis to scroll using the wheel.</p>
</dd>
<dt><code>duration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd><p>The duration of the scroll action.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Interactions.Interaction.html">Interaction</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.Interactions.Interaction.html">Interaction</a> representing the wheel scroll.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Interactions_WheelInputDevice_ToDictionary_" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.ToDictionary*"></a>
<h3 id="OpenQA_Selenium_Interactions_WheelInputDevice_ToDictionary" data-uid="OpenQA.Selenium.Interactions.WheelInputDevice.ToDictionary">
ToDictionary()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L58"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Returns a value for this input device that can be transmitted across the wire to a remote end.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override 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>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary&lt;TKey, TValue&gt;</a> representing this action.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Interactions/WheelInputDevice.cs/#L29" 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>