SearchPanel

TDataGridEh.SearchPanel

 property SearchPanel: TDataGridSearchPanelEh;

published

Use this property to set up a dedicated search bar at the top of the grid for searching and filtering data in the grid.

The SearchPanel property is of type TDataGridSearchPanelEh and contains the following subproperties:

SearchPanel.CellBeginsWithMode

property CellBeginsWithMode: Boolean default False;

Specifies that the search result must match from the start of cell.

SearchPanel.Enabled

property Enabled: Boolean default False;

Set the Enabled property to True to activate the search and filter of the panel. Activate the Panel still does not mean that it will be immediately visible in the grid. Panel's visibility is set through PersistentShowing property.

SearchPanel.FilterEnabled

property FilterEnabled: Boolean default True;

Specifies that filter is available in the search panel.

SearchPanel.FilterOnTyping

property FilterOnTyping: Boolean default False;

Specifies that the grid will filter data as the user enter text in the text editor panel of the search. If FilterOnTyping = False then the data will be filtered only by pressing the key «Enter» or click the Apply Filter button in the search panel.

SearchPanel.Location

property Location: TSearchPanelLocationEh default TSearchPanelLocationEh.GridTop;

Location of the search panel. Can take the following values:

GridTop - Search panel at the top of the grid above the title.
HorzScrollBarExtraPanel - Search panel is in the "extra-bar" thumb scroll horizontally. The search panel works correctly in this location, "extra-panel" slider is visible.
External - Search panel is outside the grid. In this mode, the algorithm of the search panel and drawing the sole responsibility of the developer.
CellInplace - SearchPanel is not displayed on the screen, but when switching to search mode and as the user presses keyboard keys, the found text will be highlighted in the current cell. To switch to search mode, the user must press Ctrl+F.

SearchPanel.OptionsPopupMenuItems

property OptionsPopupMenuItems: TDataGridSearchPanelOptionsMenuItemsEh default [SearchScopes, CaseSensitive, WholeWords, BeginsWith];

Specify a list of elements of the drop-down menu that appears on click of Search Options ("...") button in SearchPanel.
TDBGridSearchPanelOptionsMenuItemsEh type may comprise the following meanings

SearchScopes – Show menu item - Search scopes.
CaseSensitive – Show menu item - Search in case-sensitive mode.
WholeWords – Show menu item - Search by full word.
BeginsWith – Show menu item - Search for values that start from the beginning of the text contained in the cell.

SearchPanel.PersistentShowing

property PersistentShowing: Boolean default True;

Specifies that the search panel always visible in the grid. If PersistentShowing = False, the panel becomes visible after pressing the key combination to activate the search through the panel in the property ShortCut.

SearchPanel.PreferSearchToEdit

property PreferSearchToEdit: Boolean default False;

PreferSearchToEdit - Specifies that, in the TSearchPanelLocationEh.CellInplace display mode, when the user starts typing text in a cell, the grid should go into search mode instead of opening a text editor for the cell text.

SearchPanel.SearchScope

property SearchScope: TDataGridSearchPanelScopeEh default TDataGridSearchPanelScopeEh.EntireGrid;

Specifies the search area that runs by default in Search Panel
The property can be one of the following values:

CurrentColumn – Search in the current column.
EntireGrid – Search in the entire grid.

SearchPanel.ShortCut

property ShortCut: TShortCut;

Specifies the key combination to activate the search panel and give focus to the input text editor search bar. Defaults to Ctrl + F.

SearchPanel.WholeWords

property WholeWords: Boolean default False;

Specifies that the search should compare the entire contents of the cell.
If WholeWords = False then the grid will search for any subtext in the grid cell that falls within the searching text.