Documentation

Class FileSearchProviderBase

Base abstract class for file searching in windows file system.

Inheritance
System.Object
FileSearchProviderBase
FileSearchProvider
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.FileSearch
Assembly: Telerik.WinControls.UI.dll

Syntax

public abstract class FileSearchProviderBase : IFileSearchProvider, IDisposable

Constructors

FileSearchProviderBase()

Initializes a new instance of the FileSearchProviderBase class.

Declaration
protected FileSearchProviderBase()

FileSearchProviderBase(SearchSettings)

Initializes a new instance of the FileSearchProviderBase class.

Declaration
protected FileSearchProviderBase(SearchSettings settings)
Parameters
SearchSettings settings

Properties

SearchSettings

Gets or sets the search settings for this FileSearchProvider instance.

Declaration
public SearchSettings SearchSettings { get; set; }
Property Value
SearchSettings

Implements

Methods

CancelCurrentSearchAsync()

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

Declaration
public void CancelCurrentSearchAsync()
Implements

Dispose()

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

GetPropertyValueProvider(OleDbDataReader)

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

Declaration
protected abstract IPropertyValueProvider GetPropertyValueProvider(OleDbDataReader oleDbReader)
Parameters
System.Data.OleDb.OleDbDataReader oleDbReader

Returns
IPropertyValueProvider

GetPropertyValueProvider(String)

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

Declaration
protected abstract IPropertyValueProvider GetPropertyValueProvider(string pathToFileOrDir)
Parameters
System.String pathToFileOrDir

Returns
IPropertyValueProvider

GetSearchQuery(String, String)

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

Declaration
protected abstract string GetSearchQuery(string pattern, string dirPath)
Parameters
System.String pattern

System.String dirPath

Returns
System.String

SearchAsync(String, String)

Searches for string pattern in the specified directory.

Declaration
public void SearchAsync(string pattern, string dirPath)
Parameters
System.String pattern

System.String dirPath

Implements

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
public void SearchAsyncWithTimer(string pattern, string dirPath)
Parameters
System.String pattern

System.String dirPath

Implements

StopSearch()

Stops the current search operation and releases the resources.

Declaration
public void StopSearch()
Implements

Events

FileSearchCompleted

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

Declaration
public event EventHandler<FileSearchCompletedEventArgs> FileSearchCompleted
Event Type
System.EventHandler<FileSearchCompletedEventArgs>

Implements

FileSearchProgressChanged

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

Declaration
public event EventHandler<FileSearchProgressChangedEventArgs> FileSearchProgressChanged
Event Type
System.EventHandler<FileSearchProgressChangedEventArgs>

Implements

Extension Methods