Regular Expression

Defines a regular expression for pattern matching and extraction.

Remarks

The RegularExpression class provides a configurable way to define and apply regular expressions for extracting, matching, or validating text within Grooper. It supports advanced features such as prefix and suffix patterns, named output groups, and .NET RegexOptions.

Overview

• Use this class to define a regular expression pattern for locating and extracting data from text.
• Supports optional prefix and suffix patterns to further constrain matches.
• Allows selection of a named group as the output value, enabling extraction of specific subcomponents.
• Exposes .NET RegexOptions for case sensitivity, multiline, and other behaviors.

How It Works

1. The main 'Pattern' property defines the core regular expression.
2. If 'Prefix Pattern' or 'Suffix Pattern' are set, they are combined with the main pattern to require context before or after each match.
3. The regular expression is compiled using the specified 'Options'.
4. When matching, if 'Output Group' is set, only the value of that named group is returned; otherwise, the full match is used.

Usage Guidance

• Use the 'Pattern' property for the main expression.
• Use 'Prefix Pattern' and 'Suffix Pattern' to require context (such as a label or delimiter) before or after the match.
• Set 'Output Group' to extract a specific named group from the match.
• Adjust 'Options' for case sensitivity, multiline, and other behaviors as needed.

Properties

Name	Type		Description
Pattern	String	►	The main regular expression pattern used for matching. EditorRegex Property Editor Requiredtrue Enter a valid .NET regular expression. This pattern defines the core logic for what will be matched or extracted. Use named groups (e.g., (?<MyGroup>...)) to enable extraction of subcomponents via the 'Output Group' property.
Prefix Pattern	String	►	An optional regular expression that must occur immediately before each match. EditorRegex Property Editor If set, the main pattern will only match when preceded by this prefix. Useful for requiring a label, delimiter, or other context before the value. Uses .NET regular expression syntax.
Suffix Pattern	String	►	An optional regular expression that must occur immediately after each match. EditorRegex Property Editor If set, the main pattern will only match when followed by this suffix. Useful for requiring a delimiter, unit, or other context after the value. Uses .NET regular expression syntax.
Options	RegexOptions	►	Options that control the behavior of the regular expression engine. ConverterPg Flags Converter DefaultNone A combination of the following flags: Name Value Description None 0 IgnoreCase 1 Multiline 2 ExplicitCapture 4 Compiled 8 Singleline 16 IgnorePatternWhitespace 32 RightToLeft 64 ECMAScript 256 CultureInvariant 512 Select from .NET RegexOptions such as IgnoreCase, Multiline, or ExplicitCapture. These options affect how the pattern is interpreted and matched. For example, use 'IgnoreCase' to make matching case-insensitive.
Output Group	String	►	The name of a regex named group to use as the output value. ConverterGroup Converter Can be one of the following types: Value Description If set, only the value of this named group will be returned for each match. Leave blank to use the entire match value. Named groups are defined in the pattern using the syntax (?<GroupName>...).

Derived Types

There are 2 implementations of Regular Expression.

Attribute Rule	Configures how attributes are applied to HTML elements during Condition HTML processing.
Wrap Rule	Matches a text pattern in the HTML text nodes

Used By

Text Document - Insert Page BreaksText Document - NormalizeQuery XMLQuery HTMLHyperlink Selector