Instance Searcher

Displays a search interface for locating and reviewing data instances within a Data Grid.

Remarks

Overview

The Instance Searcher control provides an interactive UI for searching, filtering, and reviewing data instances within a Data Grid. It enables users to specify search criteria using selector expressions, preview results, and refine their queries using code editors with syntax highlighting and auto-completion.

Purpose and Usage

• Use this control to locate specific records, fields, or containers within a Data Grid by entering selector queries.
• Supports advanced search scenarios, including filtering by record type, value, or custom logic.
• Results are displayed in a grid format, allowing users to review, select, and interact with matching instances.

UI Components

• Record Selector Editor:
  An interactive code editor for entering the main search query.
  • Features syntax highlighting and auto-completion for selector expressions.
  • Accepts Grooper selector syntax to target records or containers.
  • Example:
    Section[Name == "Invoices"]
• Value Selectors Editor:
  A code editor for specifying which values or fields to display for each search result.
  • Supports syntax highlighting.
  • Example:
    Field[CodeName == "InvoiceNumber"], Field[CodeName == "Total"]
• Hit List:
  Displays the set of matching instances found by the search.
  • Results are shown in a tabular format, with columns defined by the value selectors.
  • Users can review, select, and interact with results.

How to Use

1. Enter a selector query in the Record Selector Editor to define which records or containers to search.
2. Optionally, specify value selectors in the Value Selectors Editor to choose which fields to display.
3. The control will display matching instances in the Hit List grid.
4. Use context menu commands or keyboard shortcuts to interact with results.

Keyboard Shortcuts

• Ctrl + F: Focus the search editor.
• Enter: Execute the search.
• Esc: Clear the current query.

Examples

• To find all invoice sections: Section[Type == "Invoice"]
• To display only the "Invoice Number" and "Total" fields for each result: Field[CodeName == "InvoiceNumber"], Field[CodeName == "Total"]

For more information, see the documentation for Data Grid, Code Editor, and Instance Result Set.

Child Controls

Name	Type		Summary
Record Selector Editor	Code Editor	►	Provides an interactive code editor for entering the main search query. Overview The Record Selector Editor allows users to enter Grooper selector expressions to define which records or containers to search. Features Syntax highlighting for selector expressions. Auto-completion for available fields and containers. Inline error detection for invalid queries. Usage Type a selector expression to target specific records. Use auto-completion to quickly insert field or container names. Press Enter to execute the search. Example Section[Name == "Invoices"]
Value Selectors Editor	Code Editor	►	Provides a code editor for specifying which values or fields to display for each search result. Overview The Value Selectors Editor enables users to choose which fields or values to display in the search results. Features Syntax highlighting for value selector expressions. Supports multiple selectors, separated by commas. Usage Enter one or more value selectors to define result columns. Example selectors: Field[CodeName == "InvoiceNumber"], Field[CodeName == "Total"]
Hit List	Instance Result Set	►	Displays the set of matching instances found by the search query. Overview The Hit List control presents the results of the current search in a tabular format. Each row represents a matching instance, and columns are defined by the value selectors entered by the user. Usage Review the list of matching records, fields, or containers. Select rows to view details or perform actions. Use context menu commands for additional operations. Example After searching for invoice sections, the Hit List will display each matching section, with columns for "Invoice Number" and "Total" if specified.