Interface
IFileSearchProvider

Provides file / folder search in the windows file system.

Definition

Namespace:Telerik.Windows.Controls.FileSearch

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
public interface IFileSearchProvider

Properties

SearchSettings

Settings for customizing the search operation.

Declaration

cs-api-definition
SearchSettings SearchSettings { get; }

Property Value

SearchSettings

Methods

CancelCurrentSearchAsync()

Cancels the current search asynchronously. Should be invoked when search string is changed.

Declaration

cs-api-definition
void CancelCurrentSearchAsync()

SearchAsync(string, string)

Searches for string pattern in the specified directory.

Declaration

cs-api-definition
void SearchAsync(string pattern, string dirPath)

Parameters

pattern

string

dirPath

string

SearchAsyncWithTimer(string, string)

Performs async search with background timer which supports fast changing of the search parameters. Suitable when typing the search string in a TextBox.

Declaration

cs-api-definition
void SearchAsyncWithTimer(string pattern, string dirPath)

Parameters

pattern

string

dirPath

string

StopSearch()

Stops the current search operation and releases the resources.

Declaration

cs-api-definition
void StopSearch()

Events

FileSearchCompleted

Fires when search is completed automatically or by the user via cancellation.

Declaration

cs-api-definition
event EventHandler<FileSearchCompletedEventArgs> FileSearchCompleted

Event Value

EventHandler<FileSearchCompletedEventArgs>

FileSearchProgressChanged

Fires when chunk (portion) of files is found.

Declaration

cs-api-definition
event EventHandler<FileSearchProgressChangedEventArgs> FileSearchProgressChanged

Event Value

EventHandler<FileSearchProgressChangedEventArgs>