Class provides quick search routines for finding an element(s) within a document.
Inheritance Hierarchy
ArtOfTest.WebAii.CoreFind
ArtOfTest.WebAii.Controls.HtmlControlsHtmlFind
Namespace: ArtOfTest.WebAii.Core
Assembly: ArtOfTest.WebAii (in ArtOfTest.WebAii.dll) Version: 2018.1.116.0 (2018.1.116.0)
Syntax
The Find type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AssociatedBrowser |
Gets the browser object that is associated with this find object.
If this property is null, then the Find object is associated with a search region.
|
| FindReferenceType |
Gets the reference type that this Find object is using. (i.e. browser root, testregion ... etc)
|
| IgnoreFindAllControlMismatch |
Gets/Sets whether to ignore Find.Allxx<TControl>(...) elements
that don't match the TControl specified. (i.e. the TControl type validation fails for
that element). If false, the Find.Allxx method will throw an exception.
|
| LastFindParam |
Gets the last FindParam used to search.
|
| LastSearchLog |
Gets the search log for the last find attempt. This log can help diagnose when
find fails to locate an element.
|
| SearchRegion |
Gets the search region for this Find object. When this is set to a specific region, all search is done locale
to that region. All indexes are calculated starting at zero from this region's element.
If this property is null, then the Find object will perform all searches from the document
root element.
|
| SearchRootElement |
Gets/Sets the root element that all searches will be performed under.
This element depended on the reference type. [Browser/TestRegion/Element].
|
| ThrowIfNullOrEmpty |
Gets/Sets whether to throw an exception if any of the find methods returns a null element or any of
the find all methods return empty list of elements.
|
Methods
| Name | Description | |
|---|---|---|
 | AllByAttributes(String) |
Returns a list of elements that have attributes that match the NameValuePairs passed it
fully or partially.
|
| AllByAttributesTControl(String) |
Returns a list of elements that have attributes that match the NameValuePairs passed it
fully or partially.
|
 | AllByContent(String) |
Returns a list of elements that have TextContent that match the specified content
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples Remarks Text1
InnerText for div1 : Text1Text2 {recursive}
TextContent of div1 : Text1 {non-recursive}
Default for ByContent is TextContent which is the most common usage.
Text2 |
| AllByContent(String, FindContentType) |
Returns a list of elements that match the specified content.
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples Remarks Text1
InnerText for div1 : Text1Text2 {recursive}
TextContent of div1 : Text1 {non-recursive}
Default for ByContent is TextContent which is the most common usage.
Text2 |
| AllByContentTControl(String) |
Returns a list of elements that have TextContent that match the specified content
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples Remarks Text1
InnerText for div1 : Text1Text2 {recursive}
TextContent of div1 : Text1 {non-recursive}
Default for ByContent is TextContent which is the most common usage.
Text2 |
| AllByContentTControl(String, FindContentType) |
Returns a list of elements that match the specified content.
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples Remarks Text1
InnerText for div1 : Text1Text2 {recursive}
TextContent of div1 : Text1 {non-recursive}
Default for ByContent is TextContent which is the most common usage.
Text2 |
| AllByCustom(PredicateElement) |
Return all elements that match the predicate
|
| AllByCustomTControl(PredicateTControl) |
Returns all controls that match the predicate and are convertable to TControl.
|
| AllByExpression(String) |
Find all elements by HTML find expression strings.
|
| AllByExpression(HtmlFindExpression) |
Find all elements by HtmlFindExpression.
|
| AllByExpressionTControl(String) |
Find all elements by HTML find expression strings of type TControl.
|
| AllByExpressionTControl(HtmlFindExpression) |
Find all elements by HtmlFindExpression of type TControl.
|
| AllByTagName(String) |
Returns a list of elements with a specific tag name.
|
| AllByTagNameTControl(String) |
Returns a list of elements with a specific tag name as a control collection.
|
| AllByXPath(String) |
Returns a list of elements that match the specified XPath. This function supports
the System.Xml XPath syntax.
|
| AllByXPathTControl(String) |
Returns a list of elements that match the specified XPath. This function supports
the System.Xml XPath syntax.
|
| AllControlsTControl |
Gets an IEnmerable for TControl to be used for LINQ queries.
This will return only elements that are convertable to TControl
|
| AllElements |
Gets a IEnumerable for all elements to be used for LINQ queries
|
 | BuildBestFitFindExpression |
Generates a HtmlFindExpression to be used to find the specified element.
The function uses an algorithm optimized for most reliable search methods
and will revert back to using the tagname index as a last resort
|
| ByAttributes(String) |
Returns a an element that has attributes that match the NameValuePairs passed it.
All matching is case-insensitive.
|
| ByAttributesTControl(String) |
Same as ByAttributes(). Returns a control type instead of element.
|
| ByContent(String) |
Returns an element by searching its TextContent.
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples |
| ByContent(String, FindContentType) |
Returns an element by searching its content with the options to pick the
content type. (InnerText, InnerMarkup or OuterMarkup)
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples Remarks Text1
InnerText for div1 : Text1Text2 {recursive}
TextContent of div1 : Text1 {non-recursive}
Default for ByContent is TextContent which is the most common usage.
Text2 |
| ByContent(String, FindContentType, String) |
Returns an element by searching its content with the options to pick the
content type. (InnerText, InnerMarkup or OuterMarkup) in addition to a list
of attributes.
The content must start with:
'l:' for exact match strings, 'p:' for partial strings or 'x:' for regular expression
matches. If none are provided, the string will be matched using an exact match 'l:'.
All searches are case-insensitive.
Examples Remarks Text1
InnerText for div1 : Text1Text2 {recursive}
TextContent of div1 : Text1 {non-recursive}
Default for ByContent is TextContent which is the most common usage.
Text2 |
| ByContentTControl(String) |
Same as ByContent(). Returns a control type instead of element.
|
| ByContentTControl(String, FindContentType) |
Same as ByContent(). Returns a control type instead of element.
|
| ByContentTControl(String, FindContentType, String) |
Same as ByContent(). Returns a control type instead of element.
|
| ByCustom(PredicateElement) |
Return the element that matches the defined predicate.
|
| ByCustomTControl(PredicateTControl) |
Get a control by using custom predicate. This function will try to eliminate any elements
that are not convertable to TControl type.
|
| ByExpression(String) |
Find element by HTML find expression strings.
|
| ByExpression(HtmlFindExpression) |
Find element by HtmlFindExpression.
|
| ByExpression(HtmlFindExpression, Boolean) |
Find Element by HtmlFindExpression.
|
| ByExpressionTControl(String) |
Find element by HTML find expression strings of type TControl.
|
| ByExpressionTControl(HtmlFindExpression) |
Find element by HtmlFindExpression of type TControl.
|
| ById(String) |
Returns an element by looking for its 'id' attribute value.
|
| ByIdTControl(String) |
Same as ById(). Returns a control type instead of element.
|
| ByName(String) |
Returns an element by searching for its 'name' attribute value
|
| ByNameTControl(String) |
Same as ByName(). Returns a control type instead of element.
|
| ByNodeIndexPath(String) |
Returns an element by searching for it using a node index path.
Examples For example: This call: ByNodeIndexPath("0/2/0/1") describes the <target></target> element in the below hierarchy: <referenceElement> (0)<foo> <bar> </bar> <car> </car> (2)<bus> (0)<driver> <cap> </cap> (1)<target> </target> </driver> </bus> </foo> </referenceElement> |
| ByNodeIndexPathTControl(String) |
Same as ByNodexIndexPath(). Returns a control type instead of element.
|
| ByTagIndex(String, Int32) |
Returns an element by its tag name occrrence.
|
| ByTagIndexTControl(String, Int32) |
Same as ByTagIndex(). Returns a control type instead of element.
|
| ByXPath(String) |
Returns an element using an XPath. This function supports
the System.Xml XPath syntax.
|
| ByXPathTControl(String) |
Same as ByXPath(). Returns a control type instead of element.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FromCollection |
Finds all elements with the HtmlFindExpressions in the collection.
|
| FromExpressionsFile |
Finds all elements with FindExpressions defined in a file.
|
| FromExpressionsXml |
Finds all elements with FindExpressions defined in the serialized xml string.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | ReturnedNullOrEmpty |
Invoked when one of the find methods returns null or an empty list of elements.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | jQuery |
Creates and returns a new jQuery object for the Find object.
(Defined by jQueryExtension.) |
See Also