FindParam Class

Progress Software Corporation - Testing Framework 2018.1 Automation Infrastructure

Note: This API is now obsolete.

A class that defines how a search for an element should be conducted within a document.
Inheritance Hierarchy


Namespace:  ArtOfTest.WebAii.ObjectModel
Assembly:  ArtOfTest.WebAii (in ArtOfTest.WebAii.dll) Version: 2018.1.116.0 (2018.1.116.0)

[ObsoleteAttribute("FindParam will be removed in next release. Please use HtmlFindExpression or XamlFindExpressions instead. FindParam.ToFindExpression() can help you convert your current FindParams to FindExpressions")]
public class FindParam : INotifyPropertyChanged, IFindParam

The FindParam type exposes the following members.


Public methodFindParam
Create a new FindParam
Public methodFindParam(Int32)
Create a new find parameter of Type=NodeIndexPath
Public methodFindParam(String)
Create a new find parameter using name-value pairs of attributes.
Public methodFindParam(HtmlFindExpression)
Create a new find param of type.
Public methodFindParam(String, Int32)
Create a new find parameter of Type=TagIndex
Public methodFindParam(String, Int32, String)
Create a new find parameter of Type=TagIndex with additional attributes to use to find the element or verify it.
Public methodFindParam(FindType, String, String)
Create a new FindParam by explicitly specifying the FindType.

Public propertyAttributes
Gets/Sets the list of Attributes to use for identification.
Public propertyConstraints
Gets or sets a constraint for this FindParam
Public propertyContentType
Gets/Sets the content type when the identification type is Content. (Default:TextContent)
Public propertyCode exampleContentValue
Gets/Sets the content value to find when type is Content. This can be a string to validate against or a regular expression. 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.

To find tags with innerText content is: 'foo bar' Example 1: 'l:foo bar' Example 2: 'p:foo' Example 3: 'x:foo\s*bar'
Public propertyExcludedAttributes
Gets/Sets the list of attribute to exclude for identification.
Public propertyExpression
The HtmlFindExpression used if Type=Expression.
Public propertyNodeIndexPath
Gets/Sets Hierarchal path from the reference element when Type=NodeIndexPath.
Public propertyPartialAttributes
Gets/Sets the partial attribute values to use for identification.
Public propertySearchAttributes
List of (partial & exact) attributes to use for identification.
Public propertyTagIndex
Gets/Sets tagName occurrence index when Type=TagIndex
Public propertyTagName
Gets/Sets the tagName of the element this parameter identifies.
Public propertyType
Gets/Sets the identification type to use to identify this element. (Default:TagIndex)
Public propertyXPath
Gets/Sets the XPath to use when Type=XPath.

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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberLoadFromFile
Load a FindParam from a file.
Public methodStatic memberLoadFromXml
Load a FindParam from an xml persisted string.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberNewExpr
Create a FindParam object from an expression.
Public methodSave
Serializes and saves the current FindParam to a file. You can later load that file using FindParam.Load().
Public methodSetAttributes
Used to initialize a list of parameter value pairs on a FindParam.
Public methodSetContent
Sets the content type and returns the updated FindParam.
Public methodSetTagName
Sets the tag name and returns the updated FindParam.
Public methodToString
String representation of the FindParam.
(Overrides ObjectToString.)
Public methodToXml
Serialize and return the current FindParam as a string. You can later use that string to create a FindParam using the .Load().

Public eventPropertyChanged
Occurs when a property changes on this FindParam object.
Extension Methods

Public Extension MethodToExpression
Convert a FindParam legacy object to a HtmlFindExpression
(Defined by FindParamExtension.)
See Also