New to Telerik UI for WPF? Start a free 30-day trial

FileSearchProviderBase

Class

Base abstract class for file searching in windows file system.

Definition

Namespace:Telerik.Windows.Controls.FileSearch

Assembly:Telerik.Windows.Controls.dll

Syntax:

public abstract class FileSearchProviderBase : IFileSearchProvider, IDisposable

Inheritance: objectFileSearchProviderBase

Derived Classes: FileSearchProvider

Implements: IDisposableIFileSearchProvider

Constructors

FileSearchProviderBase()

Initializes a new instance of the FileSearchProviderBase class.

protected FileSearchProviderBase()

FileSearchProviderBase(SearchSettings)

Initializes a new instance of the FileSearchProviderBase class.

protected FileSearchProviderBase(SearchSettings settings)

Parameters:settingsSearchSettings

Properties

SearchSettings

Gets or sets the search settings for this FileSearchProvider instance.

public SearchSettings SearchSettings { get; set; }

Implements: IFileSearchProvider.SearchSettings

Methods

CancelCurrentSearchAsync()

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

public void CancelCurrentSearchAsync()

Implements: IFileSearchProvider.CancelCurrentSearchAsync()

Dispose()

public void Dispose()

Implements: IDisposable.Dispose()

Dispose(bool)

protected virtual void Dispose(bool isDisposing)

Parameters:isDisposingbool

GetPropertyValueProvider(OleDbDataReader)

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

protected abstract IPropertyValueProvider GetPropertyValueProvider(OleDbDataReader oleDbReader)

Parameters:oleDbReaderOleDbDataReaderReturns:

IPropertyValueProvider

GetPropertyValueProvider(string)

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

protected abstract IPropertyValueProvider GetPropertyValueProvider(string pathToFileOrDir)

Parameters:pathToFileOrDirstringReturns:

IPropertyValueProvider

GetSearchQuery(string, string)

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

protected abstract string GetSearchQuery(string pattern, string dirPath)

Parameters:patternstringdirPathstringReturns:

string

SearchAsync(string, string)

Searches for string pattern in the specified directory.

public void SearchAsync(string pattern, string dirPath)

Parameters:patternstringdirPathstring

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.

public void SearchAsyncWithTimer(string pattern, string dirPath)

Parameters:patternstringdirPathstring

Implements: IFileSearchProvider.SearchAsyncWithTimer(string, string)

StopSearch()

Stops the current search operation and releases the resources.

public void StopSearch()

Implements: IFileSearchProvider.StopSearch()

Events

FileSearchCompleted

EventHandler<FileSearchCompletedEventArgs>

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

public event EventHandler<FileSearchCompletedEventArgs> FileSearchCompleted

Implements: IFileSearchProvider.FileSearchCompleted

FileSearchProgressChanged

EventHandler<FileSearchProgressChangedEventArgs>

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

public event EventHandler<FileSearchProgressChangedEventArgs> FileSearchProgressChanged

Implements: IFileSearchProvider.FileSearchProgressChanged