HtmlFind Class

Progress Software Corporation - Testing Framework 2018.1 Automation Infrastructure
Extends the generic Find methods to include HTML specific find objects.
Inheritance Hierarchy

SystemObject
  ArtOfTest.WebAii.CoreFind
    ArtOfTest.WebAii.Controls.HtmlControlsHtmlFind

Namespace:  ArtOfTest.WebAii.Controls.HtmlControls
Assembly:  ArtOfTest.WebAii (in ArtOfTest.WebAii.dll) Version: 2018.1.116.0 (2018.1.116.0)
Syntax

public class HtmlFind : Find

The HtmlFind type exposes the following members.

Constructors

  NameDescription
Public methodHtmlFind
Create a new Find object.
Top
Properties

  NameDescription
Public propertyAssociatedBrowser
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.
(Inherited from Find.)
Public propertyFindReferenceType
Gets the reference type that this Find object is using. (i.e. browser root, testregion ... etc)
(Inherited from Find.)
Public propertyIgnoreFindAllControlMismatch
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.
(Inherited from Find.)
Public propertyLastFindParam
Gets the last FindParam used to search.
(Inherited from Find.)
Public propertyLastSearchLog
Gets the search log for the last find attempt. This log can help diagnose when find fails to locate an element.
(Inherited from Find.)
Public propertySearchRegion
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.
(Inherited from Find.)
Public propertySearchRootElement
Gets/Sets the root element that all searches will be performed under. This element depended on the reference type. [Browser/TestRegion/Element].
(Inherited from Find.)
Public propertyThrowIfNullOrEmpty
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.
(Inherited from Find.)
Top
Methods

  NameDescription
Public methodAllByAttributes(String)
Returns a list of elements that have attributes that match the NameValuePairs passed it fully or partially.
(Inherited from Find.)
Public methodCode exampleAllByContent(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

To find tags with TextContent of: 'foo bar' Example 1: ByContent("l:foo bar"); Example 2: ByContent("p:foo"); Example 3: ByContent("x:[*foo*]");
Remarks

There is a difference between FindContentType.InnerText and FindContentType.TextContent that is worth noting: Example:
Text1
Text2
InnerText for div1 : Text1Text2 {recursive} TextContent of div1 : Text1 {non-recursive} Default for ByContent is TextContent which is the most common usage.
(Inherited from Find.)
Public methodCode exampleAllByContent(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

To find tags with TextContent of: 'foo bar' Example 1: ByContent("l:foo bar"); Example 2: ByContent("p:foo"); Example 3: ByContent("x:[*foo*]");
Remarks

There is a difference between FindContentType.InnerText and FindContentType.TextContent that is worth noting: Example:
Text1
Text2
InnerText for div1 : Text1Text2 {recursive} TextContent of div1 : Text1 {non-recursive} Default for ByContent is TextContent which is the most common usage.
(Inherited from Find.)
Public methodAllByCustom(PredicateElement)
Return all elements that match the predicate
(Inherited from Find.)
Public methodAllByCustomTControl(PredicateTControl)
Returns all controls that match the predicate and are convertable to TControl.
(Inherited from Find.)
Public methodAllByExpression(String)
Find all elements by HTML find expression strings.
(Inherited from Find.)
Public methodAllByExpression(HtmlFindExpression)
Find all elements by HtmlFindExpression.
(Inherited from Find.)
Public methodAllByTagName(String)
Returns a list of elements with a specific tag name.
(Inherited from Find.)
Public methodAllByXPath(String)
Returns a list of elements that match the specified XPath. This function supports the System.Xml XPath syntax.
(Inherited from Find.)
Public methodAllControlsTControl
Gets an IEnmerable for TControl to be used for LINQ queries. This will return only elements that are convertable to TControl
(Inherited from Find.)
Public methodAllElements
Gets a IEnumerable for all elements to be used for LINQ queries
(Inherited from Find.)
Public methodByAttributes(String)
Returns a an element that has attributes that match the NameValuePairs passed it. All matching is case-insensitive.
(Inherited from Find.)
Public methodCode exampleByContent(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

To find tags with innerText content is: 'foo bar' Example 1: ByContent("l:foo bar"); Example 2: ByContent("p:foo"); Example 3: ByContent("x:[*foo*]");
(Inherited from Find.)
Public methodCode exampleByContent(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

Similar to Find.ByContent(string) with the option to specify the content type: Example 1: ByContent("l:foo bar",FindContentType.InnerText); Example 2: ByContent("p:<foo id="f" />",FindContent.OuterMarkup);
Remarks

There is a difference between FindContentType.InnerText and FindContentType.TextContent that is worth noting: Example:
Text1
Text2
InnerText for div1 : Text1Text2 {recursive} TextContent of div1 : Text1 {non-recursive} Default for ByContent is TextContent which is the most common usage.
(Inherited from Find.)
Public methodCode exampleByContent(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

Similar to Find.ByContent(string) with the option to specify the content type: Example 1: ByContent("l:foo bar",FindContentType.InnerText); Example 2: ByContent("p:<foo id="f" />",FindContent.OuterMarkup);
Remarks

There is a difference between FindContentType.InnerText and FindContentType.TextContent that is worth noting: Example:
Text1
Text2
InnerText for div1 : Text1Text2 {recursive} TextContent of div1 : Text1 {non-recursive} Default for ByContent is TextContent which is the most common usage.
(Inherited from Find.)
Public methodByCustom(PredicateElement)
Return the element that matches the defined predicate.
(Inherited from Find.)
Public methodByCustomTControl(PredicateTControl)
Get a control by using custom predicate. This function will try to eliminate any elements that are not convertable to TControl type.
(Inherited from Find.)
Public methodByExpression(HtmlFindExpression, Boolean) (Inherited from Find.)
Public methodByExpressionTControl(String)
Find element by HTML find expression strings of type TControl.
(Inherited from Find.)
Public methodByExpressionTControl(HtmlFindExpression)
Find element by HtmlFindExpression of type TControl.
(Inherited from Find.)
Public methodById(String)
Returns an element by looking for its 'id' attribute value.
(Inherited from Find.)
Public methodByName(String)
Returns an element by searching for its 'name' attribute value
(Inherited from Find.)
Public methodCode exampleByNodeIndexPath(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>
(Inherited from Find.)
Public methodByTagIndex(String, Int32)
Returns an element by its tag name occrrence.
(Inherited from Find.)
Public methodByXPath(String)
Returns an element using an XPath. This function supports the System.Xml XPath syntax.
(Inherited from Find.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFromCollection
Finds all elements with the HtmlFindExpressions in the collection.
(Inherited from Find.)
Public methodFromExpressionsFile
Finds all elements with FindExpressions defined in a file.
(Inherited from Find.)
Public methodFromExpressionsXml
Finds all elements with FindExpressions defined in the serialized xml string.
(Inherited from Find.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodTable
Finds the first table that contains the cell text content specified.
Public methodTableCell
Finds the first table cell that contains the text content specified. If the text is contained by a control inside that table cell, this method will not find that cell.
Public methodTableRow
Finds the first table row that contains the cell text content specified.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventReturnedNullOrEmpty
Invoked when one of the find methods returns null or an empty list of elements.
(Inherited from Find.)
Top
Extension Methods

  NameDescription
Public Extension MethodjQuery
Creates and returns a new jQuery object for the Find object.
(Defined by jQueryExtension.)
Top
See Also

Reference