Click or drag to resize

PdfSearchResults Class

Defines result of a search operation.
Inheritance Hierarchy
SystemObject
  Atalasoft.Pdf.TextExtractPdfSearchResults

Namespace:  Atalasoft.Pdf.TextExtract
Assembly:  Atalasoft.dotImage.PdfReader (in Atalasoft.dotImage.PdfReader.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class PdfSearchResults : IDisposable

The PdfSearchResults type exposes the following members.

Properties
  NameDescription
Public propertyCharCount
Gets start number of characters that comprise current search result.
Public propertyHasResults
Gets a value indicating whether results of the search operation exist or not.
Public propertyStartIndex
Gets start index of the current search result.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the PdfSearchResults
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the PdfSearchResults and optionally releases the managed resources
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 it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindNext
Moves to the next search result.
Public methodFindPrevious
Moves to the previous search result.
Public methodGetHashCode
Serves as the default hash function.
(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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
This class is similar to IEnumerable in a sense that you need to call FindNext to get the first search result. In other words, right after the search operation, PdfSearchResuls instance is positioned before first search result.
See Also