This class helps you to extract the text from PDF documents and to search text in PDF documents
Inheritance Hierarchy
HiQPdfClientPdfTextExtract
Namespace: HiQPdfClient
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 15.0.0
Syntax
The PdfTextExtract type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PdfTextExtract(String) |
Creates a PDF to Text converter to connect on default port to a server given by IP address or by host name
|
| PdfTextExtract(String, UInt32) |
Creates a PDF to Text converter to connect on the given port to a server given by IP address or by host name
|
Properties
| Name | Description | |
|---|---|---|
 | MaxRunTime |
The maximum time to run the PDF text extraction
|
| OwnerPassword |
The password to open the PDF document in owner mode
|
| PageBreaksEnabled |
Controls if a special character is inserted in the extracted text to mark the page breaks from the source PDF document
|
| PdfInfo |
Gets the object encapsulating the PDF document properties. This objects is populated after
tool execution finished
|
| Port |
The server port number
|
| SerialNumber |
The serial number obtained after product purchase. This property can be set to null or can be left not set to enter evaluation mode
|
| Server |
The server IP address or host name
|
| ServerPassword |
The password to access the server if the server is password protected
|
| TextExtractMode |
The text extraction mode
|
| UserPassword |
The password to open the PDF document in user mode
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExtractText(Byte) |
Call this method to extract the text from a PDF document contained in a memory buffer
|
| ExtractText(Stream) |
Call this method to extract the text from a PDF document contained in a stream
|
| ExtractText(String) |
Call this method to extract the text from a PDF file
|
| ExtractText(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
|
| ExtractText(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
|
| ExtractText(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
|
| ExtractText(Byte, Int32, Int32) |
Call this method to extract the text from a range of pages of a PDF document contained in a memory buffer
|
| ExtractText(Stream, Int32, Int32) |
Call this method to extract the text from a range of pages of a PDF document contained in a stream
|
| ExtractText(String, Int32, Int32) |
Call this method to extract the text from a range of pages of a PDF file
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PdfPageCount(Byte) |
Call this method to get the page count of a PDF document contained in a memory buffer
|
| PdfPageCount(Stream) |
Call this method to get the page count of a PDF document contained in a stream
|
| PdfPageCount(String) |
Call this method to get the page count of a PDF file
|
| SearchText(Byte, String, Boolean, Boolean) |
Call this method to search text in a PDF document contained in a memory buffer
|
| SearchText(Stream, String, Boolean, Boolean) |
Call this method to search a text in a PDF document contained in a stream
|
| SearchText(String, String, Boolean, Boolean) |
Call this method to search a text in a PDF file
|
| SearchText(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
|
| SearchText(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
|
| SearchText(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
|
| SearchText(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
|
| SearchText(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
|
| SearchText(String, String, Int32, Int32, Boolean, Boolean) |
Call this method search a text in a range of pages of a PDF file
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | PageBreakChar |
The character to mark the page breaks in the extracted text
|
See Also