Class
FileSearchProviderBase

Base abstract class for file searching in windows file system.

Definition

Namespace:Telerik.Windows.Controls.FileSearch

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
public abstract class FileSearchProviderBase : IFileSearchProvider, IDisposable

Inheritance: objectFileSearchProviderBase

Derived Classes: FileSearchProvider

Implements: IDisposableIFileSearchProvider

Constructors

FileSearchProviderBase()

Initializes a new instance of the FileSearchProviderBase class.

Declaration

cs-api-definition
protected FileSearchProviderBase()

FileSearchProviderBase(SearchSettings)

Initializes a new instance of the FileSearchProviderBase class.

Declaration

cs-api-definition
protected FileSearchProviderBase(SearchSettings settings)

Parameters

settings

SearchSettings

Properties

SearchSettings

Gets or sets the search settings for this FileSearchProvider instance.

Declaration

cs-api-definition
public SearchSettings SearchSettings { get; set; }

Property Value

SearchSettings

Implements IFileSearchProvider.SearchSettings

Methods

CancelCurrentSearchAsync()

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

Declaration

cs-api-definition
public void CancelCurrentSearchAsync()

Implements IFileSearchProvider.CancelCurrentSearchAsync()

Dispose()

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

Dispose(bool)

Declaration

cs-api-definition
protected virtual void Dispose(bool isDisposing)

Parameters

isDisposing

bool

GetPropertyValueProvider(OleDbDataReader)

Gets the IPropertyValueProvider associated with the current OleDbDataReader when searching in indexed locations.

Declaration

cs-api-definition
protected abstract IPropertyValueProvider GetPropertyValueProvider(OleDbDataReader oleDbReader)

Parameters

oleDbReader

OleDbDataReader

Returns

IPropertyValueProvider

GetPropertyValueProvider(string)

Gets the IPropertyValueProvider associated with the current file result when searching in non-indexed locations.

Declaration

cs-api-definition
protected abstract IPropertyValueProvider GetPropertyValueProvider(string pathToFileOrDir)

Parameters

pathToFileOrDir

string

Returns

IPropertyValueProvider

GetSearchQuery(string, string)

Gets the 'SQL'-like search query when searching in indexed locations.

Declaration

cs-api-definition
protected abstract string GetSearchQuery(string pattern, string dirPath)

Parameters

pattern

string

dirPath

string

Returns

string

SearchAsync(string, string)

Searches for string pattern in the specified directory.

Declaration

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

Parameters

pattern

string

dirPath

string

Implements IFileSearchProvider.SearchAsync(string, 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
public void SearchAsyncWithTimer(string pattern, string dirPath)

Parameters

pattern

string

dirPath

string

Implements IFileSearchProvider.SearchAsyncWithTimer(string, string)

StopSearch()

Stops the current search operation and releases the resources.

Declaration

cs-api-definition
public void StopSearch()

Implements IFileSearchProvider.StopSearch()

Events

FileSearchCompleted

Fires when the current search operation is completed, whether cancelled or not.

Declaration

cs-api-definition
public event EventHandler<FileSearchCompletedEventArgs> FileSearchCompleted

Event Value

EventHandler<FileSearchCompletedEventArgs>

Implements IFileSearchProvider.FileSearchCompleted

FileSearchProgressChanged

Fires on every portion of files found. The size of the portion is determined by the ResultsChunkItemsCount property of the SearchSettings.

Declaration

cs-api-definition
public event EventHandler<FileSearchProgressChangedEventArgs> FileSearchProgressChanged

Event Value

EventHandler<FileSearchProgressChangedEventArgs>

Implements IFileSearchProvider.FileSearchProgressChanged