Filter items in FileExplorer
Starting from Q1 2011 the users can filter the files and folders in the FileExplorer's Grid. Setting the EnableFilterTextBox property to true will render a search box above the Grid's header. Note that the FileExplorer searches for the keyword in the currently selected directory, omitting the items in the subfolders.
These are the properties the related to the Filtering functionality:
EnableFilterTextBox - When set to true, renders a textbox used to filter files in the grid.
EnableFilteringOnEnterPressed - When set to true, performs the filtering after the "Enter" key is pressed. Its default value is false which means the items are filtered on every keystroke. Note that, the filter box must be enabled for this property to be considered, i.e. the previous property must be set to true.
FilterTextBoxLabel - Gets or sets the text of the label displayed next to the Filter TextBox.
The filter client-side event (OnClientFilter property) is raised before the filtering occurs, and event argument object with the following properties and methods is passed to the event handler method:
get_text() - gets the text (keyword) to search for
set_text(newText) - sets the text (keyword) to search for
set_cancel(toCancel) - sets bool value that determines whether the filtering will be cancelled. For example, set_cancel(true) will cancel the filtering process.
get_domEvent() - gets a reference to the current domEvent object - it comes handy when you need to determine which key was pressed
It is not necessary to have the built-in filter textbox enabled in order to perform filtering. The FileExplorer's filter( client-side method can be used to filter the items in the currently selected directory. For example the following code performs the search from a user-defined textbox on every key stroke.