[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications, and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Property Grid
  [Expand]Pivot Grid
  [Expand]Member Tables
  [Collapse]Tree List
   [Expand]Product Information
   [Expand]Feature Center
   [Collapse]Visual Elements
     Automatic Filtering Row
     Blank Column
     Caption Panel
     Cell
     Column
     Column Button
     Column Header
     Column Header Context Menu
     Column Header Panel
     Column Separators
     Column's Filter DropDown
     Customization Form
     Empty Area
     Expand Button
     Filter Button
     Filter Editor
     Filter Panel
     Find Panel
     Fixed Line
     Footer Cell
     Footer Context Menu
     Group Footer
     Node Image
     Node Indents
     Node Indicator Panel
     Summary Footer
   [Expand]Design-Time Features
   [Expand]Examples
   [Expand]End User Capabilities
   [Expand]Member Tables
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
  [Expand]Sunburst Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Find Panel

Expanded Overview

The tree list can display a find panel that enables users to search for keywords in data.

Note

Run the XtraTreeList demo to see the find panel in action.

Keyboard operations

  • press Ctrl+F to open the find panel
  • press Esc once to clear the panel, press it again to close it
  • press the Down Arrow key to move focus from the panel to the grid
  • press F3/Enter to go to the next result (in Search mode only)
  • press Shift/Alt/Ctrl+F3/Enter to go to the previous result (in Search mode only)

Expanded Behavior: Search and Filter

You can specify how to show search results.

  • Filter — hides records that do not match the query, and optionally highlights results in the tree list.
  • Search — highlights results in the tree list and on the scrollbar.

Use the following properties to specify how to show search results:

Expanded Options

The TreeList.OptionsFind property provides access to options specific to the find panel.

Panel visibility

Specify search queries in code

Note

If the TreeListOptionsFilter.FilterMode property is set to Standard, the child nodes that meet the search query are only displayed if their parent nodes also meet the query.

Highlight results

To specify whether search queries are highlighted, use the TreeListOptionsFind.HighlightFindResults property.

Auto-apply search queries

After a user types in the search box, the search starts automatically or manually depending on the underlying data source. You can use use the TreeListOptionsFind.FindMode property to specify this behavior explicitly. The TreeListOptionsFind.FindDelay property allows you to specify the delay between entering the query and starting the search.

Operation buttons

Use the following properties to show/hide the buttons.

Filter and Search modes

Filter mode only

Search mode only

Expanded Search Syntax

Use the following syntax to search for keywords via the find panel. Queries are not case-sensitive.

Single/multiple keywords: type a single keyword or multiple keywords separated by spaces. For example:

  • USA — selects records that contain "USA" in any column;
  • Germany Spain — either "Germany" or "Spain" in any column.

Exact match of a phrase: put the phrase in quotes. For example,

  • "Bottom-Dollar Markets" — selects records that contain the phrase "Bottom-Dollar Markets" in any column.

A keyword is mandatory: precede a keyword with "+" (no space between them). For example:

  • Agent Manager +London — the selected records should contain "London", and either "Agent" or "Manager" in any column;
  • "Marketing Manager" +"Carine Schmitt" — the selected records should contain "Carine Schmitt" and "Marketing Manager" in any column.

Exclude keywords: precede a condition with "-" (without a space). For example,

  • Manager -Schmitt — records should contain "Manager", but not "Schmitt".

In specific columns only: enter a column name before a keyword followed by a colon (without a space). For example:

  • City:Madrid — selects records that contain "Madrid" in the "City" column only;
  • Country:USA Manager — "USA" in the "Country" column and "Manager" anywhere else;
  • "Sales Representative" -City:London — searches for "Sales Representative", but not in "London".

Users can enter incomplete column names. In this case, a control shows records from the first column whose name matches the entered string. For example,

  • Ci:Madrid — selects records that contain "Madrid" in the first column whose name starts with "Ci" ("City" in this case).

To specify an exact name or if a name contains multiple words, use quotes. For example:

  • "Contact Title":Manager"Manager" in the "Contact Title" column exactly;

Keywords that have a column name as a prefix are also mandatory. For example,

  • Country:USA Seattle Portland — the selected records should contain "USA" in the "Country" column, and either "Seattle" or "Portland" in any column;
  • USA Seattle Portland — the selected records contain "USA" or "Seattle" or "Portland" in any column.
Important

Starting with version 19.1, the search syntax may vary depending on the TreeListOptionsFind.ParserKind and TreeListOptionsFind.Condition settings.

Is this topic helpful?​​​​​​​