List Searcher

Displays a searchable list of values for a Data Grid Field, allowing the user to select a value.

Remarks

Overview

The List Searcher control provides an interactive, searchable list of possible values for a Data Field. Users can quickly filter, browse, and select a value from the list, streamlining data entry and review.

Purpose and Usage

• Use this control to select a value for a field from a managed list of choices, such as a dropdown, picklist, or lookup result.
• Supports both static lists (from a Lexicon or field configuration) and dynamic lists (populated from external sources).
• Designed for rapid selection, validation, and user guidance in data entry workflows.

UI Components

• Search Input:
  A text box at the top of the control allows users to filter the list by entering search terms or regular expressions.
  • As you type, the list is filtered in real time.
  • Supports partial matches and full regular expression patterns.
  • Example: Enter TX to show only values containing "TX".
  • Example: Enter ^A to show only values starting with "A".
  • Example: Enter Corp$ to show only values ending with "Corp".
  • Example: Enter ^[A-Z]{2}$ to show only two-letter codes.
  • Example: Enter .vendor. to match any value or remark containing "vendor".
  • The filter applies to both the value and remarks columns.
  • If the search box is empty, all choices are shown.
  • Invalid regex patterns will not filter any results.
• Choice List:
  Displays all available choices for the field, including value and remarks.
  • Each row shows a possible value and its description or remarks.
  • Double-click a row or press Enter to select the value.
• Context Menu and Keyboard Shortcuts:
  • Enter: Select the highlighted value.
  • Esc: Close the dialog without selecting.
  • Up/Down: Navigate the list.
  • Ctrl + F: Focus the search input.

How to Use

1. Type in the search box to filter the list of choices using plain text or a regular expression.
2. Browse the filtered results and select the desired value.
3. Double-click a value or press Enter to confirm your selection.
4. The selected value is applied to the field in the Data Grid.

Regex Search Details

• The search input supports full .NET regular expression syntax.
• Filtering is case-sensitive.
• The filter is applied to the entire row text (value and remarks).
• Examples:
  • ^TX$ matches only the value "TX".
  • Approved|Pending matches any row with "Approved" or "Pending" in value or remarks.
  • ^[A-Z]{2}$ matches two uppercase letters (e.g., state codes).
  • vendor matches any row containing "vendor" in value or remarks.
  • ^.{3,}$ matches values with three or more characters.
• For advanced filtering, use regex anchors (^, $), character classes ([A-Z]), quantifiers (*, +, {n}), and alternation (|).

Examples

• State/Province Field:
  AL | Alabama TX | Texas NY | New York Type TX or ^T to quickly find and select "Texas".
• Reason Codes:
  100 | Approved 200 | Pending 300 | Rejected Type Pending or ^2 to filter and select the "200 | Pending" entry.
• Vendor List:
  ACME Corp | Preferred vendor WidgetCo | Standard supplier Type Corp$ or vendor to select "ACME Corp".

Child Controls

• Object List: Renders the list of choices and manages selection, navigation, and display.

Additional Features

• Supports regular expression filtering for advanced search scenarios.
• Remarks or descriptions are shown alongside each value to provide context.
• The control is fully keyboard-accessible for efficient data entry.

Related Concepts

• Data Field: The field for which choices are presented.
• Lexicon: Source of static or dynamic choice values.
• Object List: Underlying grid control for displaying choices.

For more information, see the documentation for Data Field, Lexicon, and Object List.

Child Controls