| |
| PDFTron SilverDox SDK |
| TextSearch..::..OnTextSearchAsyncCallbackArgs Members |
| TextSearch..::..OnTextSearchAsyncCallbackArgs Class Properties See Also Send Feedback |
TextSearch searches through a Document for a user-given search pattern. TextSearch provides users with several useful search modes and extra information besides the found string that matches the pattern. TextSearch can either keep running until a matched string is found or be set to return periodically in order for the caller to perform any necessary updates (e.g., UI updates).
The TextSearch..::..OnTextSearchAsyncCallbackArgs type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AmbientString |
The text surrounding the ResultString.
|
| AsyncState |
Gets a user-defined object that qualifies or contains information about an asynchronous operation.
|
| AsyncWaitHandle |
Gets a WaitHandle that is used to wait for an asynchronous operation to complete.
|
| CompletedSynchronously |
Gets a value that indicates whether the asynchronous operation completed synchronously.
|
| Error |
If an error has occured, Error contains information about the error; otherwise, Error is null.
|
| IsCompleted |
Gets a value that indicates whether the asynchronous operation has completed.
|
| PageNumber |
The page number which the search was conducted on.
|
| Quads |
A list of Quads, representing the bounding box(es) of the found text. Useful for highlighting the text.
|
| ResultCode |
The reason the search completed.
|
| ResultString |
The found text.
|
See Also
Send comments on this topic to [email protected]
© 2010-2012 PDFTron Systems, Inc. All Rights Reserved.