Find Panel
- 2 minutes to read
Overview
The grid can display a find panel that enables users to search for keywords in data. The panel searches against records in the vertical grid, and property names in the property grid.
Note
Run the XtraVerticalGrid 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
Options
The VGridControl.OptionsFind property provides access to options specific to the find panel.
Panel visibility
- VGridControl.ShowFindPanel() — opens the panel.
- VGridControl.HideFindPanel() — closes the panel.
- VGridControl.OptionsFind.Visibility — gets or sets whether the panel is shown/hidden with Ctrl+F, or always/never visible.
Highlight results
To specify whether search queries are highlighted, use the VGridControl.OptionsFind.HighlightFindResults property.
Specify search queries in code
- VGridControl.ApplyFindFilter(System.String) — fills in the find panel with the specified query and applies it.
- VGridControl.ClearFindFilter — discards the query and clears the find panel.
- VGridControl.CustomRecordFilter — allows you to hide a particular record regardless of the applied filter.
- VGridControl.OptionsFind.FindFilterColumns — names of rows in which to search the keywords (the vertical grid only).
Search Syntax
The search syntax can vary depending on the VGridControl.OptionsFind.ParserKind and VGridControl.OptionsFind.Condition properties. See Find Panel Syntax for more information.
Operation buttons
VGridControl.OptionsFind.ShowCloseButton — the X button that closes the panel.
VGridControl.OptionsFind.ShowFindButton — the Find button that applies the query.
- VGridControl.OptionsFind.ShowClearButton — the Clear button.
Auto-apply search queries
After a user types in the search box, the search starts automatically depending on the underlying data source. You can use use the VGridControl.OptionsFind.FindMode property to specify this behavior. The VGridControl.OptionsFind.FindDelay property allows you to specify the delay between when you enter a query and when the search starts.