SearchClient ClassDocument Toolkit Help
Provides asynchronous full text search capabilities.
Inheritance Hierarchy

SystemObject
  FirstFloor.Documents.ComponentModelAsyncOperationClient
    FirstFloor.Documents.SearchSearchClient

Namespace: FirstFloor.Documents.Search
Assembly: FirstFloor.Documents (in FirstFloor.Documents.dll) Version: 2.5.0.0 (2.5.11.0)
Syntax

public class SearchClient : AsyncOperationClient

The SearchClient type exposes the following members.

Constructors

  NameDescription
Public methodSearchClient
Initializes a new instance of the SearchClient class
Top
Properties

  NameDescription
Protected propertyCurrentOperation
Gets the operation available on the current thread.
(Inherited from AsyncOperationClient.)
Public propertyIsBusy
Gets a value indicating whether the AsyncOperationClient is running an asynchronous operation.
(Inherited from AsyncOperationClient.)
Protected propertyIsCurrentOperationCancelled
Determines whether the operation running on the current thread is cancelled.
(Inherited from AsyncOperationClient.)
Top
Methods

  NameDescription
Protected methodBeginOperation
Begins a new async operation.
(Inherited from AsyncOperationClient.)
Public methodCancelAsync
Cancels the current pending asynchronous operation.
(Inherited from AsyncOperationClient.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSearchAsync(XpsDocument, SearchQuery)
Starts an asynchronous text search operation.
Public methodSearchAsync(XpsDocument, SearchQuery, IPageFilter)
Starts an asynchronous text search operation.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventSearchCompleted
Occurs when a search text operation has completed.
Public eventSearchResultsAvailable
Occurs when text search results are available from an active search text operation.
Top
See Also

Reference