Documentation

Class Find

Inheritance
System.Object
Find
HtmlFind
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ArtOfTest.WebAii.Core
Assembly: ArtOfTest.WebAii.dll

Syntax

public class Find

Properties

AssociatedBrowser

Declaration
public Browser AssociatedBrowser { get; }
Property Value
Browser

FindReferenceType

Declaration
public FindReferenceType FindReferenceType { get; }
Property Value
FindReferenceType

IgnoreFindAllControlMismatch

Declaration
public bool IgnoreFindAllControlMismatch { get; set; }
Property Value
System.Boolean

LastFindParam

Declaration
public FindParam LastFindParam { get; }
Property Value
FindParam

LastSearchLog

Declaration
public string LastSearchLog { get; }
Property Value
System.String

SearchRegion

Declaration
public TestRegion SearchRegion { get; }
Property Value
TestRegion

SearchRootElement

Declaration
public Element SearchRootElement { get; }
Property Value
Element

ThrowIfNullOrEmpty

Declaration
public bool ThrowIfNullOrEmpty { get; set; }
Property Value
System.Boolean

Methods

AllByAttributes(String[])

Declaration
public ReadOnlyCollection<Element> AllByAttributes(params string[] nameValuePairs)
Parameters
System.String[] nameValuePairs

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByAttributes<TControl>(String[])

Declaration
public ReadOnlyCollection<TControl> AllByAttributes<TControl>(params string[] nameValuePairs)
    where TControl : Control, new()
Parameters
System.String[] nameValuePairs

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByContent(String)

Declaration
public ReadOnlyCollection<Element> AllByContent(string textContent)
Parameters
System.String textContent

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByContent(String, FindContentType)

Declaration
public ReadOnlyCollection<Element> AllByContent(string content, FindContentType contentType)
Parameters
System.String content

FindContentType contentType

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByContent<TControl>(String)

Declaration
public ReadOnlyCollection<TControl> AllByContent<TControl>(string textContent)
    where TControl : Control, new()
Parameters
System.String textContent

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByContent<TControl>(String, FindContentType)

Declaration
public ReadOnlyCollection<TControl> AllByContent<TControl>(string content, FindContentType contentType)
    where TControl : Control, new()
Parameters
System.String content

FindContentType contentType

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByCssSelector(String)

Declaration
public ReadOnlyCollection<Element> AllByCssSelector(string selector)
Parameters
System.String selector

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByCssSelector<TControl>(String)

Declaration
public ReadOnlyCollection<TControl> AllByCssSelector<TControl>(string selector)
    where TControl : Control, new()
Parameters
System.String selector

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByCustom(Predicate<Element>)

Declaration
public ReadOnlyCollection<Element> AllByCustom(Predicate<Element> predicate)
Parameters
System.Predicate<Element> predicate

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByCustom<TControl>(Predicate<TControl>)

Declaration
public ReadOnlyCollection<TControl> AllByCustom<TControl>(Predicate<TControl> predicate)
    where TControl : Control, new()
Parameters
System.Predicate<TControl> predicate

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByExpression(HtmlFindExpression)

Declaration
public ReadOnlyCollection<Element> AllByExpression(HtmlFindExpression expression)
Parameters
HtmlFindExpression expression

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByExpression(String[])

Declaration
public ReadOnlyCollection<Element> AllByExpression(params string[] expression)
Parameters
System.String[] expression

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByExpression<TControl>(HtmlFindExpression)

Declaration
public ReadOnlyCollection<TControl> AllByExpression<TControl>(HtmlFindExpression expression)
    where TControl : Control, new()
Parameters
HtmlFindExpression expression

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByExpression<TControl>(String[])

Declaration
public ReadOnlyCollection<TControl> AllByExpression<TControl>(params string[] expression)
    where TControl : Control, new()
Parameters
System.String[] expression

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByImage(Image, Double, Boolean, Point, Int32, Single, Int32)

Declaration
public ReadOnlyCollection<Element> AllByImage(Image image, double score, bool autoScroll = true, Point probeOffset = null, int timeout = 2147483647, float imageScale = 1F, int searchDelay = 100)
Parameters
System.Drawing.Image image

System.Double score

System.Boolean autoScroll

System.Drawing.Point probeOffset

System.Int32 timeout

System.Single imageScale

System.Int32 searchDelay

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByTagName(String)

Declaration
public ReadOnlyCollection<Element> AllByTagName(string tagName)
Parameters
System.String tagName

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByTagName<TControl>(String)

Declaration
public ReadOnlyCollection<TControl> AllByTagName<TControl>(string tagName)
    where TControl : Control, new()
Parameters
System.String tagName

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllByXPath(String)

Declaration
public ReadOnlyCollection<Element> AllByXPath(string xpath)
Parameters
System.String xpath

Returns
System.Collections.ObjectModel.ReadOnlyCollection<Element>

AllByXPath<TControl>(String)

Declaration
public ReadOnlyCollection<TControl> AllByXPath<TControl>(string xpath)
    where TControl : Control, new()
Parameters
System.String xpath

Returns
System.Collections.ObjectModel.ReadOnlyCollection<TControl>

Type Parameters
TControl

AllControls<TControl>()

Declaration
public IEnumerable<TControl> AllControls<TControl>()
    where TControl : Control, new()
Returns
System.Collections.Generic.IEnumerable<TControl>

Type Parameters
TControl

AllElements()

Declaration
public IEnumerable<Element> AllElements()
Returns
System.Collections.Generic.IEnumerable<Element>

BuildBestFitFindExpression(Element)

Declaration
public static HtmlFindExpression BuildBestFitFindExpression(Element element)
Parameters
Element element

Returns
HtmlFindExpression

ByAttributes(String[])

Declaration
public Element ByAttributes(params string[] nameValuePairs)
Parameters
System.String[] nameValuePairs

Returns
Element

ByAttributes<TControl>(String[])

Declaration
public TControl ByAttributes<TControl>(params string[] nameValuePairs)
    where TControl : Control, new()
Parameters
System.String[] nameValuePairs

Returns
TControl

Type Parameters
TControl

ByContent(String)

Declaration
public Element ByContent(string content)
Parameters
System.String content

Returns
Element

ByContent(String, FindContentType)

Declaration
public Element ByContent(string content, FindContentType contentType)
Parameters
System.String content

FindContentType contentType

Returns
Element

ByContent(String, FindContentType, String[])

Declaration
public Element ByContent(string content, FindContentType contentType, params string[] nameValuePairs)
Parameters
System.String content

FindContentType contentType

System.String[] nameValuePairs

Returns
Element

ByContent<TControl>(String)

Declaration
public TControl ByContent<TControl>(string content)
    where TControl : Control, new()
Parameters
System.String content

Returns
TControl

Type Parameters
TControl

ByContent<TControl>(String, FindContentType)

Declaration
public TControl ByContent<TControl>(string content, FindContentType contentType)
    where TControl : Control, new()
Parameters
System.String content

FindContentType contentType

Returns
TControl

Type Parameters
TControl

ByContent<TControl>(String, FindContentType, String[])

Declaration
public TControl ByContent<TControl>(string content, FindContentType contentType, params string[] nameValuePairs)
    where TControl : Control, new()
Parameters
System.String content

FindContentType contentType

System.String[] nameValuePairs

Returns
TControl

Type Parameters
TControl

ByCssSelector(String)

Declaration
public Element ByCssSelector(string selector)
Parameters
System.String selector

Returns
Element

ByCssSelector<TControl>(String)

Declaration
public TControl ByCssSelector<TControl>(string selector)
    where TControl : Control, new()
Parameters
System.String selector

Returns
TControl

Type Parameters
TControl

ByCustom(Predicate<Element>)

Declaration
public Element ByCustom(Predicate<Element> predicate)
Parameters
System.Predicate<Element> predicate

Returns
Element

ByCustom<TControl>(Predicate<TControl>)

Declaration
public TControl ByCustom<TControl>(Predicate<TControl> predicate)
    where TControl : Control, new()
Parameters
System.Predicate<TControl> predicate

Returns
TControl

Type Parameters
TControl

ByExpression(HtmlFindExpression)

Declaration
public Element ByExpression(HtmlFindExpression expression)
Parameters
HtmlFindExpression expression

Returns
Element

ByExpression(HtmlFindExpression, Boolean)

Declaration
public Element ByExpression(HtmlFindExpression expression, bool includeRoot)
Parameters
HtmlFindExpression expression

System.Boolean includeRoot

Returns
Element

ByExpression(String[])

Declaration
public Element ByExpression(params string[] expression)
Parameters
System.String[] expression

Returns
Element

ByExpression<TControl>(HtmlFindExpression)

Declaration
public TControl ByExpression<TControl>(HtmlFindExpression expression)
    where TControl : Control, new()
Parameters
HtmlFindExpression expression

Returns
TControl

Type Parameters
TControl

ByExpression<TControl>(String[])

Declaration
public TControl ByExpression<TControl>(params string[] expression)
    where TControl : Control, new()
Parameters
System.String[] expression

Returns
TControl

Type Parameters
TControl

ById(String)

Declaration
public Element ById(string id)
Parameters
System.String id

Returns
Element

ById<TControl>(String)

Declaration
public TControl ById<TControl>(string id)
    where TControl : Control, new()
Parameters
System.String id

Returns
TControl

Type Parameters
TControl

ByImage(Image, Double, Int32, Boolean, Point, Int32, Single, Int32)

Declaration
public Element ByImage(Image image, double score, int index = 0, bool autoScroll = true, Point probeOffset = null, int timeout = 2147483647, float imageScale = 1F, int searchDelay = 100)
Parameters
System.Drawing.Image image

System.Double score

System.Int32 index

System.Boolean autoScroll

System.Drawing.Point probeOffset

System.Int32 timeout

System.Single imageScale

System.Int32 searchDelay

Returns
Element

ByName(String)

Declaration
public Element ByName(string name)
Parameters
System.String name

Returns
Element

ByName<TControl>(String)

Declaration
public TControl ByName<TControl>(string name)
    where TControl : Control, new()
Parameters
System.String name

Returns
TControl

Type Parameters
TControl

ByNodeIndexPath(String)

Declaration
public Element ByNodeIndexPath(string nodeIndexPath)
Parameters
System.String nodeIndexPath

Returns
Element

ByNodeIndexPath<TControl>(String)

Declaration
public TControl ByNodeIndexPath<TControl>(string nodeIndexPath)
    where TControl : Control, new()
Parameters
System.String nodeIndexPath

Returns
TControl

Type Parameters
TControl

ByTagIndex(String, Int32)

Declaration
public Element ByTagIndex(string tagName, int occurrenceIndex)
Parameters
System.String tagName

System.Int32 occurrenceIndex

Returns
Element

ByTagIndex<TControl>(String, Int32)

Declaration
public TControl ByTagIndex<TControl>(string tagName, int occurrenceIndex)
    where TControl : Control, new()
Parameters
System.String tagName

System.Int32 occurrenceIndex

Returns
TControl

Type Parameters
TControl

ByXPath(String)

Declaration
public Element ByXPath(string xpath)
Parameters
System.String xpath

Returns
Element

ByXPath<TControl>(String)

Declaration
public TControl ByXPath<TControl>(string xpath)
    where TControl : Control, new()
Parameters
System.String xpath

Returns
TControl

Type Parameters
TControl

FromCollection(FindExpressionCollection<HtmlFindExpression>)

Declaration
public IDictionary<string, Element> FromCollection(FindExpressionCollection<HtmlFindExpression> collection)
Parameters
FindExpressionCollection<HtmlFindExpression> collection

Returns
System.Collections.Generic.IDictionary<System.String, Element>

FromExpressionsFile(String)

Declaration
public IDictionary<string, Element> FromExpressionsFile(string fileName)
Parameters
System.String fileName

Returns
System.Collections.Generic.IDictionary<System.String, Element>

FromExpressionsXml(String)

Declaration
public IDictionary<string, Element> FromExpressionsXml(string xml)
Parameters
System.String xml

Returns
System.Collections.Generic.IDictionary<System.String, Element>

ImageMatch(Image, Double, Int32, Int32, Single, Int32)

Declaration
public Rectangle ImageMatch(Image image, double score, int index = 0, int timeout = 2147483647, float imageScale = 1F, int searchDelay = 100)
Parameters
System.Drawing.Image image

System.Double score

System.Int32 index

System.Int32 timeout

System.Single imageScale

System.Int32 searchDelay

Returns
System.Drawing.Rectangle

ImageMatches(Image, Double, Int32, Single, Int32)

Declaration
public ReadOnlyCollection<Rectangle> ImageMatches(Image image, double score, int timeout = 2147483647, float imageScale = 1F, int searchDelay = 100)
Parameters
System.Drawing.Image image

System.Double score

System.Int32 timeout

System.Single imageScale

System.Int32 searchDelay

Returns
System.Collections.ObjectModel.ReadOnlyCollection<System.Drawing.Rectangle>

Events

ReturnedNullOrEmpty

Declaration
public event EventHandler<ReturnedNullOrEmptyEventArgs> ReturnedNullOrEmpty
Event Type
System.EventHandler<ReturnedNullOrEmptyEventArgs>

Extension Methods