HiQPdf Documentation

PdfTextExtract Class

Quickly Create High Quality PDFs
This class helps you to extract the text from PDF documents and to search text in PDF documents
Inheritance Hierarchy

SystemObject
  HiQPdfPdfTextExtract

Namespace:  HiQPdf
Assembly:  HiQPdf (in HiQPdf.dll) Version: 11.4.0.0
Syntax

public class PdfTextExtract

The PdfTextExtract type exposes the following members.

Constructors

  NameDescription
Public methodPdfTextExtract
The PDF text extractor constructor
Top
Properties

  NameDescription
Public propertyMaxRunTime
The maximum time to run the PDF text extraction
Public propertyOwnerPassword
The password to open the PDF document in owner mode
Public propertyPageBreaksEnabled
Controls if a special character is inserted in the extracted text to mark the page breaks from the source PDF document
Public propertyPdfInfo
Gets the object encapsulating the PDF document properties. This objects is populated after tool execution finished
Public propertySerialNumber
The serial number obtained after product purchase. This property can be set to null or can be left not set to enter evaluation mode
Public propertyTextExtractMode
The text extraction mode
Public propertyUserPassword
The password to open the PDF document in user mode
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExtractText(Byte)
Call this method to extract the text from a PDF document contained in a memory buffer
Public methodExtractText(Stream)
Call this method to extract the text from a PDF document contained in a stream
Public methodExtractText(String)
Call this method to extract the text from a PDF file
Public methodExtractText(Byte, Int32)
Call this method to extract the text from a PDF document contained in a memory buffer starting from a PDF page number to the end of the PDF document
Public methodExtractText(Stream, Int32)
Call this method to extract the text from a PDF document contained in a stream starting from a PDF page number to the end of the PDF document
Public methodExtractText(String, Int32)
Call this method to extract the text from a PDF file starting from a PDF page number to the end of the PDF document
Public methodExtractText(Byte, Int32, Int32)
Call this method to extract the text from a range of pages of a PDF document contained in a memory buffer
Public methodExtractText(Stream, Int32, Int32)
Call this method to extract the text from a range of pages of a PDF document contained in a stream
Public methodExtractText(String, Int32, Int32)
Call this method to extract the text from a range of pages of a PDF file
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 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 methodPdfPageCount(Byte)
Call this method to get the page count of a PDF document contained in a memory buffer
Public methodPdfPageCount(Stream)
Call this method to get the page count of a PDF document contained in a stream
Public methodPdfPageCount(String)
Call this method to get the page count of a PDF file
Public methodSearchText(Byte, String, Boolean, Boolean)
Call this method to search text in a PDF document contained in a memory buffer
Public methodSearchText(Stream, String, Boolean, Boolean)
Call this method to search a text in a PDF document contained in a stream
Public methodSearchText(String, String, Boolean, Boolean)
Call this method to search a text in a PDF file
Public methodSearchText(Byte, String, Int32, Boolean, Boolean)
Call this method to search text in a PDF document contained in a memory buffer starting from a PDF page number to the end of the PDF document
Public methodSearchText(Stream, String, Int32, Boolean, Boolean)
Call this method to search a text in a PDF document contained in a stream starting from a PDF page number to the end of the PDF document
Public methodSearchText(String, String, Int32, Boolean, Boolean)
Call this method to search a text in a PDF file starting from a PDF page number to the end of the PDF document
Public methodSearchText(Byte, String, Int32, Int32, Boolean, Boolean)
Call this method to search text in a range of pages of a PDF document contained in a memory buffer
Public methodSearchText(Stream, String, Int32, Int32, Boolean, Boolean)
Call this method to search a text in a range of pages of a PDF document contained in a stream
Public methodSearchText(String, String, Int32, Int32, Boolean, Boolean)
Call this method search a text in a range of pages of a PDF file
Public methodSetRdaFilePath
Call this method with the fully qualified name of HiQPdf.rda when this file is installed in a different folder from the HiQPdf.dll folder
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberPageBreakChar
The character to mark the page breaks in the extracted text
Top
See Also

Reference