Click or drag to resize

PdfToTextConverter Class

The PDF to Text converter class
Inheritance Hierarchy
SystemObject
  ExpertPdf.AnywherePdfToTextConverter

Namespace: ExpertPdf.Anywhere
Assembly: ExpertPdf.Anywhere (in ExpertPdf.Anywhere.dll) Version: 22.0
Syntax
public class PdfToTextConverter : IDisposable

The PdfToTextConverter type exposes the following members.

Constructors
 NameDescription
Public methodPdfToTextConverter PDF to Text converter constructor
Top
Properties
 NameDescription
Public propertyAddHtmlMetaTags When this property is true the extracted text is included in a HTML document with the meta info taken from the PDF document description. The default value is false.
Public propertyClipText Do not return hidden text from the PDF document.
Public propertyDocumentInformation PDF document information. This property is populated after the requested operation (ConvertToText) is finished.
Public propertyEndPageNumber The page number where the text extraction will end. The default value is 0 which means that all the PDF document text will be extracted starting from the StartPageNumber page.
Public propertyHtmlCharset The charset meta tag added to the generated HTML document. This property has effect only when the AddHtmlMetaTags property is true. The default value is UTF-8.
Public propertyLayout Gets or sets the layout of the output text. The default value is OriginalLayout.
Public propertyLicenseKey The license key string received after the product purchase or a demo license key for the demo version of the converter. This property must be set before calling the text extraction method. When this property is null, the converter will run in demo mode.
Public propertyMarkPageBreaks When this property is true a special character defined by the PAGE_BREAK_MARK property is inserted after the text extracted from each page. The default value is false.
Public propertyStatic memberPAGE_BREAK_MARK Gets the page break mark character used when the MarkPageBreaks property is true.
Public propertyPdfToolsFullPath Gets or sets the full path of the PDF tools engine file, or of the folder that holds it. When it is not set, the engine beside the application is used.
Public propertyPdfToolsTimeout Timeout in seconds for the current operation. Default value is 600 seconds.
Public propertyStartPageNumber The page number from where the text extraction will start. The default value is 1 which means the text extraction will start from the first page.
Public propertyUserPassword The password to be used to open the PDF document for reading: the user password or the owner password of the document. The default value is null which means that no password will be used to open the PDF document.
Top
Methods
 NameDescription
Public methodClose Releases the PDF document read by the last call. The object can be used again afterwards.
Public methodConvertToText(Stream) Converts a PDF document stream to a string.
Public methodConvertToText(String) Converts a PDF file to a string.
Public methodConvertToTextPages(Stream) Extracts the text of a PDF document stream page by page: one string for each page, in one call.
Public methodConvertToTextPages(String) Extracts the text of a PDF file page by page: one string for each page, in one call.
Public methodDispose Releases the PDF document read by the last call; the same as Close. Use the object in a using block.
Public methodExtractTextAtCoords(Stream, Int32, Double, Double, Double, Double) Extracts the text from the specified page and coordinates.
Public methodExtractTextAtCoords(String, Int32, Double, Double, Double, Double) Extracts the text from the specified page and coordinates.
Public methodExtractTextPositions(Stream, String, Boolean, Boolean) Searches for a text into a PDF document specified by a Stream.
Public methodExtractTextPositions(String, String, Boolean, Boolean) Searches for a text into a PDF file.
Public methodGetDocumentInformation(Stream) Gets the document information (title, subject, keywords, author, creator, producer, dates, the number of pages and the size and rotation of each page) of the specified PDF stream, without extracting its text.
Public methodGetDocumentInformation(String) Gets the document information (title, subject, keywords, author, creator, producer, dates, the number of pages and the size and rotation of each page) of the specified PDF file, without extracting its text.
Public methodGetPageCount(Stream) Gets the number of pages in the specified PDF stream.
Public methodGetPageCount(String) Gets the number of pages in the specified PDF file.
Public methodSearchTexts(Stream, String, Boolean, Boolean) Searches a PDF document specified by a Stream for several texts at once.
Public methodSearchTexts(String, String, Boolean, Boolean) Searches a PDF file for several texts at once.
Top
See Also