Skip to content

Commit 264538d

Browse files
craigfowlerGithub Actions Workflow (bot)
authored andcommitted
Publish updated documentation website
1 parent 72bf57b commit 264538d

19 files changed

Lines changed: 1364 additions & 1498 deletions

docs/api/CSF.Screenplay.Selenium.Builders.FindElementBuilder.html

Lines changed: 35 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -167,22 +167,22 @@ <h2 class="section" id="constructors">Constructors
167167

168168
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder__ctor_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.#ctor*"></a>
169169

170-
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder__ctor_CSF_Screenplay_Selenium_Elements_ITarget_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.#ctor(CSF.Screenplay.Selenium.Elements.ITarget)">
171-
FindElementBuilder(ITarget)
172-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L56"><i class="bi bi-code-slash"></i></a>
170+
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder__ctor_CSF_Screenplay_Selenium_Elements_IHasSearchContext_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.#ctor(CSF.Screenplay.Selenium.Elements.IHasSearchContext)">
171+
FindElementBuilder(IHasSearchContext)
172+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L68"><i class="bi bi-code-slash"></i></a>
173173
</h3>
174174

175175
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementsBuilder.html">FindElementsBuilder</a> class with the specified target.</p>
176176
</div>
177177
<div class="markdown level1 conceptual"></div>
178178

179179
<div class="codewrapper">
180-
<pre><code class="lang-csharp hljs">public FindElementBuilder(ITarget target)</code></pre>
180+
<pre><code class="lang-csharp hljs">public FindElementBuilder(IHasSearchContext searchContext)</code></pre>
181181
</div>
182182

183183
<h4 class="section">Parameters</h4>
184184
<dl class="parameters">
185-
<dt><code>target</code> <a class="xref" href="CSF.Screenplay.Selenium.Elements.ITarget.html">ITarget</a></dt>
185+
<dt><code>searchContext</code> <a class="xref" href="CSF.Screenplay.Selenium.Elements.IHasSearchContext.html">IHasSearchContext</a></dt>
186186
<dd><p>The target within which elements will be found.</p>
187187
</dd>
188188
</dl>
@@ -198,38 +198,28 @@ <h4 class="section">Parameters</h4>
198198

199199

200200

201-
<h2 class="section" id="methods">Methods
202-
</h2>
203-
204-
205-
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_AndNameIt_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.AndNameIt*"></a>
201+
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder__ctor_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.#ctor*"></a>
206202

207-
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_AndNameIt_System_String_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.AndNameIt(System.String)">
208-
AndNameIt(string)
209-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L41"><i class="bi bi-code-slash"></i></a>
203+
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder__ctor_CSF_Screenplay_Selenium_Elements_ITarget_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.#ctor(CSF.Screenplay.Selenium.Elements.ITarget)">
204+
FindElementBuilder(ITarget)
205+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L59"><i class="bi bi-code-slash"></i></a>
210206
</h3>
211207

212-
<div class="markdown level1 summary"><p>Specifies a human-readable name for the collection of elements which are found.</p>
208+
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementsBuilder.html">FindElementsBuilder</a> class with the specified target.</p>
213209
</div>
214210
<div class="markdown level1 conceptual"></div>
215211

216212
<div class="codewrapper">
217-
<pre><code class="lang-csharp hljs">public FindElementBuilder AndNameIt(string name)</code></pre>
213+
<pre><code class="lang-csharp hljs">public FindElementBuilder(ITarget target)</code></pre>
218214
</div>
219215

220216
<h4 class="section">Parameters</h4>
221217
<dl class="parameters">
222-
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
223-
<dd><p>The name for the collection of elements.</p>
218+
<dt><code>target</code> <a class="xref" href="CSF.Screenplay.Selenium.Elements.ITarget.html">ITarget</a></dt>
219+
<dd><p>The target within which elements will be found.</p>
224220
</dd>
225221
</dl>
226222

227-
<h4 class="section">Returns</h4>
228-
<dl class="parameters">
229-
<dt><a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementBuilder.html">FindElementBuilder</a></dt>
230-
<dd><p>The current instance of <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementsBuilder.html">FindElementsBuilder</a>.</p>
231-
</dd>
232-
</dl>
233223

234224

235225

@@ -241,25 +231,29 @@ <h4 class="section">Returns</h4>
241231

242232

243233

244-
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_WhichMatches_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.WhichMatches*"></a>
234+
<h2 class="section" id="methods">Methods
235+
</h2>
245236

246-
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_WhichMatches_CSF_Screenplay_Selenium_Elements_Locator_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.WhichMatches(CSF.Screenplay.Selenium.Elements.Locator)">
247-
WhichMatches(Locator)
248-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L30"><i class="bi bi-code-slash"></i></a>
237+
238+
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_AndNameIt_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.AndNameIt*"></a>
239+
240+
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_AndNameIt_System_String_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.AndNameIt(System.String)">
241+
AndNameIt(string)
242+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L42"><i class="bi bi-code-slash"></i></a>
249243
</h3>
250244

251-
<div class="markdown level1 summary"><p>Specifies a <a class="xref" href="CSF.Screenplay.Selenium.Elements.Locator.html">Locator</a> which should be used to filter the elements which are found.</p>
245+
<div class="markdown level1 summary"><p>Specifies a human-readable name for the collection of elements which are found.</p>
252246
</div>
253247
<div class="markdown level1 conceptual"></div>
254248

255249
<div class="codewrapper">
256-
<pre><code class="lang-csharp hljs">public FindElementBuilder WhichMatches(Locator locator)</code></pre>
250+
<pre><code class="lang-csharp hljs">public FindElementBuilder AndNameIt(string name)</code></pre>
257251
</div>
258252

259253
<h4 class="section">Parameters</h4>
260254
<dl class="parameters">
261-
<dt><code>locator</code> <a class="xref" href="CSF.Screenplay.Selenium.Elements.Locator.html">Locator</a></dt>
262-
<dd><p>The locator to filter the elements.</p>
255+
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
256+
<dd><p>The name for the collection of elements.</p>
263257
</dd>
264258
</dl>
265259

@@ -280,36 +274,32 @@ <h4 class="section">Returns</h4>
280274

281275

282276

283-
<h2 class="section" id="operators">Operators
284-
</h2>
285-
286-
287-
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_op_Implicit_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.op_Implicit*"></a>
277+
<a id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_WhichMatches_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.WhichMatches*"></a>
288278

289-
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_op_Implicit_CSF_Screenplay_Selenium_Builders_FindElementBuilder__CSF_Screenplay_Selenium_Questions_SingleElementPerformableWithResultAdapter_CSF_Screenplay_Selenium_Elements_SeleniumElement_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.op_Implicit(CSF.Screenplay.Selenium.Builders.FindElementBuilder)~CSF.Screenplay.Selenium.Questions.SingleElementPerformableWithResultAdapter{CSF.Screenplay.Selenium.Elements.SeleniumElement}">
290-
implicit operator SingleElementPerformableWithResultAdapter&lt;SeleniumElement&gt;(FindElementBuilder)
291-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L66"><i class="bi bi-code-slash"></i></a>
279+
<h3 id="CSF_Screenplay_Selenium_Builders_FindElementBuilder_WhichMatches_CSF_Screenplay_Selenium_Elements_Locator_" data-uid="CSF.Screenplay.Selenium.Builders.FindElementBuilder.WhichMatches(CSF.Screenplay.Selenium.Elements.Locator)">
280+
WhichMatches(Locator)
281+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs/#L31"><i class="bi bi-code-slash"></i></a>
292282
</h3>
293283

294-
<div class="markdown level1 summary"><p>Converts a <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementsBuilder.html">FindElementsBuilder</a> to a <a class="xref" href="CSF.Screenplay.Selenium.Questions.SingleElementPerformableWithResultAdapter-1.html">SingleElementPerformableWithResultAdapter&lt;TResult&gt;</a>.</p>
284+
<div class="markdown level1 summary"><p>Specifies a <a class="xref" href="CSF.Screenplay.Selenium.Elements.Locator.html">Locator</a> which should be used to filter the elements which are found.</p>
295285
</div>
296286
<div class="markdown level1 conceptual"></div>
297287

298288
<div class="codewrapper">
299-
<pre><code class="lang-csharp hljs">public static implicit operator SingleElementPerformableWithResultAdapter&lt;SeleniumElement&gt;(FindElementBuilder builder)</code></pre>
289+
<pre><code class="lang-csharp hljs">public FindElementBuilder WhichMatches(Locator locator)</code></pre>
300290
</div>
301291

302292
<h4 class="section">Parameters</h4>
303293
<dl class="parameters">
304-
<dt><code>builder</code> <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementBuilder.html">FindElementBuilder</a></dt>
305-
<dd><p>The <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementBuilder.html">FindElementBuilder</a> instance to convert.</p>
294+
<dt><code>locator</code> <a class="xref" href="CSF.Screenplay.Selenium.Elements.Locator.html">Locator</a></dt>
295+
<dd><p>The locator to filter the elements.</p>
306296
</dd>
307297
</dl>
308298

309299
<h4 class="section">Returns</h4>
310300
<dl class="parameters">
311-
<dt><a class="xref" href="CSF.Screenplay.Selenium.Questions.SingleElementPerformableWithResultAdapter-1.html">SingleElementPerformableWithResultAdapter</a>&lt;<a class="xref" href="CSF.Screenplay.Selenium.Elements.SeleniumElement.html">SeleniumElement</a>&gt;</dt>
312-
<dd><p>A <a class="xref" href="CSF.Screenplay.Selenium.Questions.SingleElementPerformableWithResultAdapter-1.html">SingleElementPerformableWithResultAdapter&lt;TResult&gt;</a> instance.</p>
301+
<dt><a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementBuilder.html">FindElementBuilder</a></dt>
302+
<dd><p>The current instance of <a class="xref" href="CSF.Screenplay.Selenium.Builders.FindElementsBuilder.html">FindElementsBuilder</a>.</p>
313303
</dd>
314304
</dl>
315305

0 commit comments

Comments
 (0)