Skip to content

MatchRule

Property Type Required Description
Action Enumeration True Valid values: Regex, Contains, StartsWith, EndsWith, Equal, ContainsIgnoreCase, StartsWithIgnoreCase, EndsWithIgnoreCase, EqualIgnoreCase, WildCard, WildcardIgnoreCase
Pattern String True Value to search for on the page. How the pattern is used is based upon the Action property of the matching rule.
Options Regex Option Array False Only necessary if Action is Regex. Valid values: None, IgnoreCase, Multiline, ExplicitCapture, Compiled, SingleLine, IgnorePatternWhitespace, RightToLeft, ECMAScript, CultureInvariant
AdditionalPatterns String Array False If supplied will try to match on the additional patterns specified. If any matches occur from Pattern or AdditionalPatterns, the result of the match is true.
PatternEncodingTypes EncodingType Array False In addition to matching against the normal pattern values, the pattern(s) will be decoded according to the values in this array before matching. Valid values are: Original, UpperCase, LowerCase, Url, Html, Base64, UrlEncodedBase64, Unicode
SearchTextEncodingTypes EncodingType Array False In addition to matching against the normal search text, search text will be decoded according to the values in this array before matching. Valid values are: Original, UpperCase, LowerCase, Url, Html, Base64, UrlEncodedBase64, Unicode
Skip Number False Number of items to skip in the resulting pattern matches
Take Number False Number of items to take in the resulting pattern matches
IsNot Boolean False Invert the true/false result of this match
MatchFilter MatchRuleFilter False If defined the match will only evaluate to true if the matching specified in this property is also true.