C1TextSearchManager Class

Provides functionality to search text in the document managed by the C1DocumentSource.

Inheritance

object

C1TextSearchManager

Implements

IDisposable

Namespace: C1.Document

Assembly: C1.Document.dll

Syntax

public class C1TextSearchManager : IDisposable

Public Class C1TextSearchManager
    Implements IDisposable

Constructors

Name	Description
C1TextSearchManager(C1DocumentSource)	Initializes a new instance of the C1TextSearchManager.

Properties

Name	Description
ActiveFoundPosition	Gets or sets the active found position, this position has different highlighting attrs.
DocumentSource	Gets the C1DocumentSource where this C1TextSearchManager searches a text.
FoundPositions	Gets the list of C1FoundPosition objects defining found text positions.
Params	Search parameters: text, etc. Initialized in the FindStartXXX() method.
Scope	Specifies the scope in C1Document where to search a text.

Methods

Name	Description
CancelAsync()	Cancels current async action and waits while action will be actually cancelled.
Dispose()	Releases all resources used by the C1TextSearchManager.
Dispose(bool)	Releases the unmanaged resources used by the C1TextSearchManager and optionally releases the managed resources.
~C1TextSearchManager()	Releases the unmanaged resources.
FindNext(C1FoundPosition)	Finds the next occurrence of a text in the document.
FindNextAsync(C1FoundPosition, bool)	Non-blocking (asynchronous) version of the FindNext(C1FoundPosition) method.
FindNextAsyncEx(C1FoundPosition, bool)	Non-blocking (asynchronous) version of the FindNext(C1FoundPosition) method.
FindPrevious(C1FoundPosition)	Finds the previous occurrence of a text in the document.
FindPreviousAsync(C1FoundPosition, bool)	Non-blocking (asynchronous) version of the FindPrevious(C1FoundPosition) method.
FindPreviousAsyncEx(C1FoundPosition, bool)	Non-blocking (asynchronous) version of the FindPrevious(C1FoundPosition) method.
FindStart(int, SearchScope, C1FindTextParams)	Finds the first occurrence of a text in the document.
FindStart(int, bool, C1FindTextParams)	Finds the first occurrence of a text in the document.
FindStartAsync(int, SearchScope, C1FindTextParams, bool)	Non-blocking (asynchronous) version of the FindStart(int, SearchScope, C1FindTextParams) method.
FindStartAsync(int, bool, C1FindTextParams, bool)	Non-blocking (asynchronous) version of the FindStart(int, bool, C1FindTextParams) method.
FindStartAsyncEx(int, SearchScope, C1FindTextParams, bool)	Non-blocking (asynchronous) version of the FindStart(int, SearchScope, C1FindTextParams) method.
FindStartAsyncEx(int, bool, C1FindTextParams, bool)	Non-blocking (asynchronous) version of the FindStart(int, bool, C1FindTextParams) method.
GetFragmentHighligh(IList<C1FragmentHighlight>, RenderFragment, C1HighlightAttrs, C1HighlightAttrs)	Fills `highlight` list for specified C1.Document.RenderFragment.
HasFoundPositions()	Checks whether FoundPositions of this C1TextSearchManager is not empty.
IsSearching()	Gets a value indicating if search is currently executing.
OnFindActionCompleted(C1FindTextAction, C1FoundPosition, Exception)	Raises the FindActionCompleted event.
OnFoundPositionsChanged()	Raises the FoundPositionsChanged event.
OnLongOperation(double, bool)	Raises the LongOperation event.
Reset()	Resets text search results.

Events

Name	Description
FindActionCompleted	Occurs when async find action completed.
FoundPositionsChanged	Occurs when the FoundPositions list is changed.
LongOperation	Occurs periodically during operations.