A class that defines how a search for an element should be conducted within a document.
Declaration Syntax| C# | Visual Basic | Visual Basic Usage |
[SerializableAttribute] public class FindParam : INotifyPropertyChanged
<SerializableAttribute> _ Public Class FindParam _ Implements INotifyPropertyChanged
Dim instance As FindParam
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | FindParam()()() |
Create a new FindParam
|
| FindParam(String, Int32) |
Create a new find parameter of Type=TagIndex
|
| FindParam(String, Int32, array<String>[]()[]) |
Create a new find parameter of Type=TagIndex with additional attributes to use to find the
element or verify it.
|
| FindParam(array<Int32>[]()[]) |
Create a new find parameter of Type=NodeIndexPath
|
| FindParam(array<String>[]()[]) |
Create a new find parameter using name-value pairs of attributes.
|
| FindParam(FindType, String, array<String>[]()[]) |
Create a new FindParam by explicitly specifying the FindType.
|
 | Attributes |
Gets/Sets the list of Attributes to use for identification.
|
| Constraints |
Gets or sets a constraint for this FindParam
|
| ContentType |
Gets/Sets the content type when the identification type is Content.
(Default:TextContent)
|
| ContentValue |
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.
Examples
To find tags with innerText content is: 'foo bar'
Example 1: 'l:foo bar'
Example 2: 'p:foo'
Example 3: 'x:foo\s*bar'
|
| Equals(Object) | (Inherited from Object.) |
| ExcludedAttributes |
Gets/Sets the list of attribute to exclude for identification.
|
 | Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
 | LoadFromFile(String) |
Load a FindParam from a file.
|
| LoadFromXml(String) |
Load a FindParam from an xml persisted string.
|
| MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| NodeIndexPath |
Gets/Sets Hierarchal path from the reference element when Type=NodeIndexPath.
|
| PartialAttributes |
Gets/Sets the partial attribute values to use for identification.
|
 | PropertyChanged |
Occurs when a property changes on this FindParam object.
|
| Save(String) |
Serialized and saves the current FindParam to a file.
You can later load that file using FindParam.Load().
|
| SearchAttributes | |
| SetAttributes(array<String>[]()[]) |
Used to initialize a list of parameter value pairs on a FindParam.
|
| SetContent(FindContentType, String) |
Sets the content type and returns the updated FindParam.
|
| SetTagName(String) |
Sets the tag name and returns the updated FindParam.
|
| TagIndex |
Gets/Sets tagName occurrence index when Type=TagIndex
|
| TagName |
Gets/Sets the tagName of the element this parameter identifies.
|
| ToString()()() |
String representation of the FindParam.
(Overrides Object.ToString()()().) |
| ToXml()()() |
Serialize and return the current FindParam as a string.
You can later use that string to create a FindParam using the .Load().
|
| Type |
Gets/Sets the identification type to use to identify this element. (Default:TagIndex)
|
| XPath |
Gets/Sets the XPath to use when Type=XPath.
|
Inheritance Hierarchy| Object | |
 | FindParam |