blob: 7ed3feb1bb18169fbcd9b2ad2ede7bc11ced2798 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface INavigation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface INavigation ">
<meta name="description" content="Defines an interface allowing the user to access the browser&#39;s history and to navigate to a given URL.">
<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_INavigation.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.INavigation%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.INavigation">
<h1 id="OpenQA_Selenium_INavigation" data-uid="OpenQA.Selenium.INavigation" class="text-break">
Interface INavigation <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.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></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Defines an interface allowing the user to access the browser's history and to
navigate to a given URL.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface INavigation</code></pre>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_INavigation_Back_" data-uid="OpenQA.Selenium.INavigation.Back*"></a>
<h3 id="OpenQA_Selenium_INavigation_Back" data-uid="OpenQA.Selenium.INavigation.Back">
Back()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L34"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Move back a single entry in the browser's history.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void Back()</code></pre>
</div>
<a id="OpenQA_Selenium_INavigation_BackAsync_" data-uid="OpenQA.Selenium.INavigation.BackAsync*"></a>
<h3 id="OpenQA_Selenium_INavigation_BackAsync" data-uid="OpenQA.Selenium.INavigation.BackAsync">
BackAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L40"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Move back a single entry in the browser's history as an asynchronous task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task BackAsync()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task object representing the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_INavigation_Forward_" data-uid="OpenQA.Selenium.INavigation.Forward*"></a>
<h3 id="OpenQA_Selenium_INavigation_Forward" data-uid="OpenQA.Selenium.INavigation.Forward">
Forward()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L46"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Move a single &quot;item&quot; forward in the browser's history.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void Forward()</code></pre>
</div>
<h4 class="section" id="OpenQA_Selenium_INavigation_Forward_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Does nothing if we are on the latest page viewed.</p>
</div>
<a id="OpenQA_Selenium_INavigation_ForwardAsync_" data-uid="OpenQA.Selenium.INavigation.ForwardAsync*"></a>
<h3 id="OpenQA_Selenium_INavigation_ForwardAsync" data-uid="OpenQA.Selenium.INavigation.ForwardAsync">
ForwardAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L52"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Move a single &quot;item&quot; forward in the browser's history as an asynchronous task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task ForwardAsync()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task object representing the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_INavigation_GoToUrl_" data-uid="OpenQA.Selenium.INavigation.GoToUrl*"></a>
<h3 id="OpenQA_Selenium_INavigation_GoToUrl_System_String_" data-uid="OpenQA.Selenium.INavigation.GoToUrl(System.String)">
GoToUrl(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L68"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Load a new web page in the current browser window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void GoToUrl(string url)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The URL to load. It is best to use a fully qualified URL</p>
</dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_INavigation_GoToUrl_System_String__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Calling the <a class="xref" href="OpenQA.Selenium.INavigation.html#OpenQA_Selenium_INavigation_GoToUrl_System_String_">GoToUrl(string)</a> method will load a new web page in the current browser window.
This is done using an HTTP GET operation, and the method will block until the
load is complete. This will follow redirects issued either by the server or
as a meta-redirect from within the returned HTML. Should a meta-redirect &quot;rest&quot;
for any duration of time, it is best to wait until this timeout is over, since
should the underlying page change while your test is executing the results of
future calls against this interface will be against the freshly loaded page.</p>
</div>
<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">url</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_INavigation_GoToUrl_" data-uid="OpenQA.Selenium.INavigation.GoToUrl*"></a>
<h3 id="OpenQA_Selenium_INavigation_GoToUrl_System_Uri_" data-uid="OpenQA.Selenium.INavigation.GoToUrl(System.Uri)">
GoToUrl(Uri)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L92"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Load a new web page in the current browser window.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void GoToUrl(Uri url)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uri">Uri</a></dt>
<dd><p>The URL to load.</p>
</dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_INavigation_GoToUrl_System_Uri__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Calling the <a class="xref" href="OpenQA.Selenium.INavigation.html#OpenQA_Selenium_INavigation_GoToUrl_System_Uri_">GoToUrl(Uri)</a> method will load a new web page in the current browser window.
This is done using an HTTP GET operation, and the method will block until the
load is complete. This will follow redirects issued either by the server or
as a meta-redirect from within the returned HTML. Should a meta-redirect &quot;rest&quot;
for any duration of time, it is best to wait until this timeout is over, since
should the underlying page change while your test is executing the results of
future calls against this interface will be against the freshly loaded page.</p>
</div>
<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">url</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_INavigation_GoToUrlAsync_" data-uid="OpenQA.Selenium.INavigation.GoToUrlAsync*"></a>
<h3 id="OpenQA_Selenium_INavigation_GoToUrlAsync_System_String_" data-uid="OpenQA.Selenium.INavigation.GoToUrlAsync(System.String)">
GoToUrlAsync(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L76"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Navigate to a url as an asynchronous task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task GoToUrlAsync(string url)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>String of where you want the browser to go.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task object representing the asynchronous operation.</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">url</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_INavigation_GoToUrlAsync_" data-uid="OpenQA.Selenium.INavigation.GoToUrlAsync*"></a>
<h3 id="OpenQA_Selenium_INavigation_GoToUrlAsync_System_Uri_" data-uid="OpenQA.Selenium.INavigation.GoToUrlAsync(System.Uri)">
GoToUrlAsync(Uri)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L100"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Navigate to a url as an asynchronous task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task GoToUrlAsync(Uri url)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uri">Uri</a></dt>
<dd><p>Uri object of where you want the browser to go.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task object representing the asynchronous operation.</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">url</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_INavigation_Refresh_" data-uid="OpenQA.Selenium.INavigation.Refresh*"></a>
<h3 id="OpenQA_Selenium_INavigation_Refresh" data-uid="OpenQA.Selenium.INavigation.Refresh">
Refresh()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L105"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Refreshes the current page.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void Refresh()</code></pre>
</div>
<a id="OpenQA_Selenium_INavigation_RefreshAsync_" data-uid="OpenQA.Selenium.INavigation.RefreshAsync*"></a>
<h3 id="OpenQA_Selenium_INavigation_RefreshAsync" data-uid="OpenQA.Selenium.INavigation.RefreshAsync">
RefreshAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.cs/#L111"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Reload the current page as an asynchronous task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task RefreshAsync()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task object representing the asynchronous operation.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/INavigation.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>