RegularExpression Object

On this page:

• Description
• Properties
  • Description read/write, IRegularExpression
  • Enabled read/write, IRegularExpression
  • Expression read/write, IRegularExpression
  • Fields read/write, IRegularExpression
  • Inline read/write, IRegularExpression
  • Sample read/write, IRegularExpression

Description

Instances of this object correspond to individual entries on the Line Expressions options page. These instances are stored by the RegularExpressions Object. Each instance represents a regular expression that is used to match unimportant text that you wish Merge to ignore when performing comparisons.

Properties

Description read/write, IRegularExpression

A human-readable description of the expression.

IDL	[propget] HRESULT Description([out, retval] BSTR* pValue) [propput] HRESULT Description([in] BSTR newValue)
.NET	String Description[get, set]

Enabled read/write, IRegularExpression

Whether or not the expression is enabled.

IDL	[propget] HRESULT Enabled([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Enabled([in] VARIANT_BOOL newValue)
.NET	Boolean Enabled[get, set]

Expression read/write, IRegularExpression

The expression definition, using regular expression syntax.

IDL	[propget] HRESULT Expression([out, retval] BSTR* pValue) [propput] HRESULT Expression([in] BSTR newValue)
.NET	String Expression[get, set]

Fields read/write, IRegularExpression

A comma-separated list of integers indicating the regular-expression sub-expressions matching text to be ignored by an expression of type Ignore sequences of characters that match the expression. Alternatively, * may be specified to ignore text matching the entire regular expression. For further information, see Edit Line Expression.

IDL	[propget] HRESULT Fields([out, retval] BSTR* pValue) [propput] HRESULT Fields([in] BSTR newValue)
.NET	String Fields[get, set]

Inline read/write, IRegularExpression

When true, the expression is of type Ignore sequences of characters that match the expression, selected on the Edit Line Expression dialog. When false, the expression is of type Force a line unchanged if any part matches the expression.

IDL	[propget] HRESULT Inline([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Inline([in] VARIANT_BOOL newValue)
.NET	Boolean Inline[get, set]

Sample read/write, IRegularExpression

A line of sample text, corresponding to the Enter a sample line here field on then Edit Line Expression dialog.

IDL	[propget] HRESULT Sample([out, retval] BSTR* pValue) [propput] HRESULT Sample([in] BSTR newValue)
.NET	String Sample[get, set]