blob: d17614e3d319c5db75c11e5ce743d771e0b6e378 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class DriverOptions </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class DriverOptions ">
<meta name="description" content="Base class for managing options specific to a browser driver.">
<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_DriverOptions.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DriverOptions%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.DriverOptions">
<h1 id="OpenQA_Selenium_DriverOptions" data-uid="OpenQA.Selenium.DriverOptions" class="text-break">
Class DriverOptions <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L114"><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></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Base class for managing options specific to a browser driver.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class DriverOptions</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">DriverOptions</span></div>
</dd>
</dl>
<dl class="typelist derived">
<dt>Derived</dt>
<dd>
<div><a class="xref" href="OpenQA.Selenium.Chromium.ChromiumOptions.html">ChromiumOptions</a></div>
<div><a class="xref" href="OpenQA.Selenium.Firefox.FirefoxOptions.html">FirefoxOptions</a></div>
<div><a class="xref" href="OpenQA.Selenium.IE.InternetExplorerOptions.html">InternetExplorerOptions</a></div>
<div><a class="xref" href="OpenQA.Selenium.Safari.SafariOptions.html">SafariOptions</a></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="constructors">Constructors
</h2>
<a id="OpenQA_Selenium_DriverOptions__ctor_" data-uid="OpenQA.Selenium.DriverOptions.#ctor*"></a>
<h3 id="OpenQA_Selenium_DriverOptions__ctor" data-uid="OpenQA.Selenium.DriverOptions.#ctor">
DriverOptions()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L123"><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.DriverOptions.html">DriverOptions</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected DriverOptions()</code></pre>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_DriverOptions_AcceptInsecureCertificates_" data-uid="OpenQA.Selenium.DriverOptions.AcceptInsecureCertificates*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_AcceptInsecureCertificates" data-uid="OpenQA.Selenium.DriverOptions.AcceptInsecureCertificates">
AcceptInsecureCertificates
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L155"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the browser should accept self-signed
SSL certificates.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool? AcceptInsecureCertificates { 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="OpenQA_Selenium_DriverOptions_BinaryLocation_" data-uid="OpenQA.Selenium.DriverOptions.BinaryLocation*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_BinaryLocation" data-uid="OpenQA.Selenium.DriverOptions.BinaryLocation">
BinaryLocation
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L229"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set or Get the location of the browser
Override in subclass</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual string? BinaryLocation { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_BrowserName_" data-uid="OpenQA.Selenium.DriverOptions.BrowserName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_BrowserName" data-uid="OpenQA.Selenium.DriverOptions.BrowserName">
BrowserName
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L139"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the name of the browser.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? BrowserName { get; protected 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_BrowserVersion_" data-uid="OpenQA.Selenium.DriverOptions.BrowserVersion*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_BrowserVersion" data-uid="OpenQA.Selenium.DriverOptions.BrowserVersion">
BrowserVersion
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L144"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the version of the browser.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? BrowserVersion { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_EnableDownloads_" data-uid="OpenQA.Selenium.DriverOptions.EnableDownloads*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_EnableDownloads" data-uid="OpenQA.Selenium.DriverOptions.EnableDownloads">
EnableDownloads
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L189"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether files may be downloaded from remote node.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool? EnableDownloads { 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="OpenQA_Selenium_DriverOptions_ImplicitWaitTimeout_" data-uid="OpenQA.Selenium.DriverOptions.ImplicitWaitTimeout*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_ImplicitWaitTimeout" data-uid="OpenQA.Selenium.DriverOptions.ImplicitWaitTimeout">
ImplicitWaitTimeout
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L223"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the implicit wait timeout, which is the amount of time the
driver should wait when searching for an element if it is not immediately
present.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan? ImplicitWaitTimeout { 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.timespan">TimeSpan</a>?</dt>
<dd></dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_DriverOptions_ImplicitWaitTimeout_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>When searching for a single element, the driver should poll the page
until the element has been found, or this timeout expires before throwing
a <a class="xref" href="OpenQA.Selenium.NoSuchElementException.html">NoSuchElementException</a>. When searching for multiple elements,
the driver should poll the page until at least one element has been found
or this timeout has expired.</p>
<p>
Increasing the implicit wait timeout should be used judiciously as it
will have an adverse effect on test run time, especially when used with
slower location strategies like XPath.
</p>
</div>
<a id="OpenQA_Selenium_DriverOptions_PageLoadStrategy_" data-uid="OpenQA.Selenium.DriverOptions.PageLoadStrategy*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_PageLoadStrategy" data-uid="OpenQA.Selenium.DriverOptions.PageLoadStrategy">
PageLoadStrategy
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L173"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the value for describing how the browser is to wait for pages to load in the browser.
Defaults to <a class="xref" href="OpenQA.Selenium.PageLoadStrategy.html#OpenQA_Selenium_PageLoadStrategy_Default">Default</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PageLoadStrategy PageLoadStrategy { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.PageLoadStrategy.html">PageLoadStrategy</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_PageLoadTimeout_" data-uid="OpenQA.Selenium.DriverOptions.PageLoadTimeout*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_PageLoadTimeout" data-uid="OpenQA.Selenium.DriverOptions.PageLoadTimeout">
PageLoadTimeout
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L204"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the page load timeout, which is the amount of time the driver
should wait for a page to load when setting the <a class="xref" href="OpenQA.Selenium.IWebDriver.html#OpenQA_Selenium_IWebDriver_Url">Url</a>
property.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan? PageLoadTimeout { 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.timespan">TimeSpan</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_PlatformName_" data-uid="OpenQA.Selenium.DriverOptions.PlatformName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_PlatformName" data-uid="OpenQA.Selenium.DriverOptions.PlatformName">
PlatformName
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L149"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the name of the platform on which the browser is running.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? PlatformName { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_Proxy_" data-uid="OpenQA.Selenium.DriverOptions.Proxy*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_Proxy" data-uid="OpenQA.Selenium.DriverOptions.Proxy">
Proxy
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L178"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="OpenQA.Selenium.DriverOptions.html#OpenQA_Selenium_DriverOptions_Proxy">Proxy</a> to be used with this browser.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Proxy? Proxy { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Proxy.html">Proxy</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_ScriptTimeout_" data-uid="OpenQA.Selenium.DriverOptions.ScriptTimeout*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_ScriptTimeout" data-uid="OpenQA.Selenium.DriverOptions.ScriptTimeout">
ScriptTimeout
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L197"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the asynchronous script timeout, which is the amount
of time the driver should wait when executing JavaScript asynchronously.
This timeout only affects the <a class="xref" href="OpenQA.Selenium.IJavaScriptExecutor.html#OpenQA_Selenium_IJavaScriptExecutor_ExecuteAsyncScript_System_String_System_Object___">ExecuteAsyncScript(string, params object?[])</a>
method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan? ScriptTimeout { 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.timespan">TimeSpan</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_UnhandledPromptBehavior_" data-uid="OpenQA.Selenium.DriverOptions.UnhandledPromptBehavior*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_UnhandledPromptBehavior" data-uid="OpenQA.Selenium.DriverOptions.UnhandledPromptBehavior">
UnhandledPromptBehavior
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L167"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the value for describing how unexpected alerts are to be handled in the browser.
Defaults to <a class="xref" href="OpenQA.Selenium.UnhandledPromptBehavior.html#OpenQA_Selenium_UnhandledPromptBehavior_Default">Default</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UnhandledPromptBehavior UnhandledPromptBehavior { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.UnhandledPromptBehavior.html">UnhandledPromptBehavior</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_UseStrictFileInteractability_" data-uid="OpenQA.Selenium.DriverOptions.UseStrictFileInteractability*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_UseStrictFileInteractability" data-uid="OpenQA.Selenium.DriverOptions.UseStrictFileInteractability">
UseStrictFileInteractability
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L184"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether &lt;input type='file'/&gt; elements
must be visible to allow uploading of files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool UseStrictFileInteractability { 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="OpenQA_Selenium_DriverOptions_UseWebSocketUrl_" data-uid="OpenQA.Selenium.DriverOptions.UseWebSocketUrl*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_UseWebSocketUrl" data-uid="OpenQA.Selenium.DriverOptions.UseWebSocketUrl">
UseWebSocketUrl
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L161"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the driver should request a URL to
a WebSocket to be used for bidirectional communication.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool? UseWebSocketUrl { 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>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_DriverOptions_AddAdditionalOption_" data-uid="OpenQA.Selenium.DriverOptions.AddAdditionalOption*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_AddAdditionalOption_System_String_System_Object_" data-uid="OpenQA.Selenium.DriverOptions.AddAdditionalOption(System.String,System.Object)">
AddAdditionalOption(string, object)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L249"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Provides a means to add additional capabilities not yet added as type safe options
for the specific browser driver.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void AddAdditionalOption(string optionName, object optionValue)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>optionName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to add.</p>
</dd>
<dt><code>optionValue</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The value of the capability to add.</p>
</dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_DriverOptions_AddAdditionalOption_System_String_System_Object__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Calling <a class="xref" href="OpenQA.Selenium.DriverOptions.html#OpenQA_Selenium_DriverOptions_AddAdditionalOption_System_String_System_Object_">AddAdditionalOption(string, object)</a>
where <code class="paramref">optionName</code> has already been added will overwrite the
existing value with the new value in <code class="paramref">optionValue</code>.</p>
</div>
<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>thrown when attempting to add a capability for which there is already a type safe option, or
when <code class="paramref">optionName</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> or the empty string.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_AddKnownCapabilityName_" data-uid="OpenQA.Selenium.DriverOptions.AddKnownCapabilityName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_AddKnownCapabilityName_System_String_System_String_" data-uid="OpenQA.Selenium.DriverOptions.AddKnownCapabilityName(System.String,System.String)">
AddKnownCapabilityName(string, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L378"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds a known capability to the list of known capabilities and associates it
with the type-safe property name of the options class to be used instead.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void AddKnownCapabilityName(string capabilityName, string typeSafeOptionName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability.</p>
</dd>
<dt><code>typeSafeOptionName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the option property or method to be used instead.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_GenerateDesiredCapabilities_" data-uid="OpenQA.Selenium.DriverOptions.GenerateDesiredCapabilities*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_GenerateDesiredCapabilities_System_Boolean_" data-uid="OpenQA.Selenium.DriverOptions.GenerateDesiredCapabilities(System.Boolean)">
GenerateDesiredCapabilities(bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L456"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Generates the current options as a capabilities object for further processing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected IWritableCapabilities GenerateDesiredCapabilities(bool isSpecificationCompliant)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>isSpecificationCompliant</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>A value indicating whether to generate capabilities compliant with the W3C WebDriver Specification.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.IWritableCapabilities.html">IWritableCapabilities</a></dt>
<dd><p>A <a class="xref" href="OpenQA.Selenium.IWritableCapabilities.html">IWritableCapabilities</a> object representing the current options for further processing.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_GenerateLoggingPreferencesDictionary_" data-uid="OpenQA.Selenium.DriverOptions.GenerateLoggingPreferencesDictionary*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_GenerateLoggingPreferencesDictionary" data-uid="OpenQA.Selenium.DriverOptions.GenerateLoggingPreferencesDictionary">
GenerateLoggingPreferencesDictionary()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L435"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Generates the logging preferences dictionary for transmission as a desired capability.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected Dictionary&lt;string, object&gt;? GenerateLoggingPreferencesDictionary()</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 logging preferences.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_GetMergeResult_" data-uid="OpenQA.Selenium.DriverOptions.GetMergeResult*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_GetMergeResult_OpenQA_Selenium_DriverOptions_" data-uid="OpenQA.Selenium.DriverOptions.GetMergeResult(OpenQA.Selenium.DriverOptions)">
GetMergeResult(DriverOptions)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L270"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Compares this <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> object with another to see if there
are merge conflicts between them.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual DriverOptionsMergeResult GetMergeResult(DriverOptions other)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>other</code> <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> object to compare with.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.Remote.DriverOptionsMergeResult.html">DriverOptionsMergeResult</a></dt>
<dd><p>A <a class="xref" href="OpenQA.Selenium.Remote.DriverOptionsMergeResult.html">DriverOptionsMergeResult</a> object containing the status of the attempted merge.</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">other</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_GetTypeSafeOptionName_" data-uid="OpenQA.Selenium.DriverOptions.GetTypeSafeOptionName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_GetTypeSafeOptionName_System_String_" data-uid="OpenQA.Selenium.DriverOptions.GetTypeSafeOptionName(System.String)">
GetTypeSafeOptionName(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L421"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the name of the type-safe option for a given capability name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected string GetTypeSafeOptionName(string capabilityName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to check.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the type-safe option for the given capability name.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_IsKnownCapabilityName_" data-uid="OpenQA.Selenium.DriverOptions.IsKnownCapabilityName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_IsKnownCapabilityName_System_String_" data-uid="OpenQA.Selenium.DriverOptions.IsKnownCapabilityName(System.String)">
IsKnownCapabilityName(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L400"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a value indicating whether the specified capability name is a known capability name which has a type-safe option.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool IsKnownCapabilityName(string capabilityName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to check.</p>
</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><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the capability name is known; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_RemoveKnownCapabilityName_" data-uid="OpenQA.Selenium.DriverOptions.RemoveKnownCapabilityName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_RemoveKnownCapabilityName_System_String_" data-uid="OpenQA.Selenium.DriverOptions.RemoveKnownCapabilityName(System.String)">
RemoveKnownCapabilityName(string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L387"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Remove a capability from the list of known capabilities</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void RemoveKnownCapabilityName(string? capabilityName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to be removed.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_SetLoggingPreference_" data-uid="OpenQA.Selenium.DriverOptions.SetLoggingPreference*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_SetLoggingPreference_System_String_OpenQA_Selenium_LogLevel_" data-uid="OpenQA.Selenium.DriverOptions.SetLoggingPreference(System.String,OpenQA.Selenium.LogLevel)">
SetLoggingPreference(string, LogLevel)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L329"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Sets the logging preferences for this driver.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetLoggingPreference(string logType, LogLevel logLevel)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>logType</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The type of log for which to set the preference.
Known log types can be found in the <a class="xref" href="OpenQA.Selenium.LogType.html">LogType</a> class.</p>
</dd>
<dt><code>logLevel</code> <a class="xref" href="OpenQA.Selenium.LogLevel.html">LogLevel</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.LogLevel.html">LogLevel</a> value to which to set the log level.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_ToCapabilities_" data-uid="OpenQA.Selenium.DriverOptions.ToCapabilities*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_ToCapabilities" data-uid="OpenQA.Selenium.DriverOptions.ToCapabilities">
ToCapabilities()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L261"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Returns the <a class="xref" href="OpenQA.Selenium.ICapabilities.html">ICapabilities</a> for the specific browser driver with these
options included as capabilities. This does not copy the options. Further
changes will be reflected in the returned capabilities.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract ICapabilities ToCapabilities()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.ICapabilities.html">ICapabilities</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.ICapabilities.html">ICapabilities</a> for browser driver with these options.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_TryGetKnownCapability_" data-uid="OpenQA.Selenium.DriverOptions.TryGetKnownCapability*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_TryGetKnownCapability_System_String_System_String__" data-uid="OpenQA.Selenium.DriverOptions.TryGetKnownCapability(System.String,System.String@)">
TryGetKnownCapability(string, out string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L411"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a value indicating whether the specified capability name is a known capability name which has a type-safe option.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool TryGetKnownCapability(string capabilityName, out string? typeSafeOptionName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to check.</p>
</dd>
<dt><code>typeSafeOptionName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the type-safe option for the given capability name, or <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> if not found.</p>
</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><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the capability name is known; otherwise <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DriverOptions_ValidateCapabilityName_" data-uid="OpenQA.Selenium.DriverOptions.ValidateCapabilityName*"></a>
<h3 id="OpenQA_Selenium_DriverOptions_ValidateCapabilityName_System_String_" data-uid="OpenQA.Selenium.DriverOptions.ValidateCapabilityName(System.String)">
ValidateCapabilityName(string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L358"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Validates the name of the capability to verify it is not a capability
for which a type-safe property or method already exists.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void ValidateCapabilityName(string? capabilityName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to validate.</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>thrown when attempting to add a capability for which there is already a type safe option, or
when <code class="paramref">capabilityName</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> or the empty string.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DriverOptions.cs/#L114" 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>