Is Match Editor

Editor for a text pattern match filter condition in the Filter Editor.

Remarks

The IsMatch Editor is a UI component in the Filter Editor control, allowing users to define and edit a filter condition that matches documents or fields based on a text pattern or search query. It is used to filter search results by testing whether the content of one or more fields contains a specified pattern, keyword, or phrase.

Purpose and Functionality

The IsMatch Editor enables users to:

• Select one or more fields to search for a text pattern or query.
• Enter a search string, keyword, or regular expression to match against the selected fields.
• Specify advanced search options, such as query mode (e.g., match any or all terms).
• View tooltips and contextual help for each field, including field type and additional guidance.
• Remove the condition using the {Delete} button.

The editor supports both simple keyword searches and advanced pattern matching, adapting to the selected fields and search mode. It provides visual cues and tooltips to assist users in constructing effective search queries.

UI Components

• Field Selector: Multi-select dropdown or list for choosing which fields to search.
• Search Input: Input box for entering the search pattern, keyword, or regular expression.
• Tooltips: Displays field-specific help and type information.
• {Delete} Button: Removes the current is-match condition from the filter.

Example

The following diagram illustrates the typical layout of the IsMatch Editor:

┌────────────────────────────────────────────────────────────────────────────┐
│ {Field Selector}   {Search Input}                                 {Delete} │
└────────────────────────────────────────────────────────────────────────────┘

• {Field Selector}: Multi-select control to choose one or more fields.
• {Search Input}: Input for the search pattern or keyword.
• {Delete}: Button to remove this condition.
• Tooltip area provides context and help for the selected field(s).

Usage Guidance

• Use the IsMatch Editor to add, edit, or remove text pattern match conditions in the search builder.
• Tooltips provide additional information about each field, including its type and any configured help text.
• The editor enforces valid combinations of fields and search patterns to prevent invalid filter criteria.
• Removing a condition is done by clicking the {Delete} button.

For more information on building search filters, see the documentation for Search Page and Filter Editor.

Command Buttons

Button	Shortcut Key		Summary
menu menu			Open the menu.
delete delete			Delete this condition.
open_jam add_parent_group			Add a new parent group above this condition.