PdfExtractor
Overview
PdfExtractor is a class in Aspose.PDF FOSS for .NET.
Inherits from: IDisposable.
Facade for extracting text and images from a PDF document.
This class declares 29 methods for PdfExtractor objects in .NET programs.
Available methods include: BindPdf, Close, Dispose, ExtractAttachment, ExtractImage, ExtractText, GetAttachNames, GetAttachment, GetAttachmentInfo, GetNextImage, GetNextPageText, GetText, and 3 additional methods.
Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: EndPage, ExtractImageMode, ExtractTextMode, IsBidi, Password, Resolution, and 2 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
StartPage | int | Read/Write | 1-based start page for extraction. |
EndPage | int | Read/Write | 1-based end page for extraction. |
ExtractTextMode | int | Read/Write | Text extraction mode. |
ExtractImageMode | ExtractImageMode | Read/Write | Image extraction strategy. |
Resolution | int | Read/Write | Rendering resolution for image extraction (DPI). |
IsBidi | bool | Read | True when the most recently extracted text contains a right-to-left script run (Hebrew, Arabic, Syriac, Thaana, etc.), i.e. |
Password | string? | Read/Write | Password used when binding an encrypted PDF. |
TextSearchOptions | Aspose.Pdf.Text.TextSearchOptions | Read/Write | Text-search options applied during ExtractText(). |
Methods
| Signature | Description |
|---|---|
PdfExtractor() | Creates an extractor with no document bound; call BindPdf before extracting. |
PdfExtractor(document: Document) | Creates an extractor bound to an already opened document. |
BindPdf(inputFile: string) | Opens the PDF file at the given path (using Password when set) and resets the page range to the whole document. |
BindPdf(document: Document) | Binds an already opened document, which the extractor does not dispose, and resets the page range to the whole document. |
BindPdf(inputStream: Stream) | Opens the PDF from the given stream (using Password when set) and resets the page range to the whole document. |
ExtractText() | Extracts the text of pages StartPage to EndPage using the current ExtractTextMode. |
ExtractText(outputFile: string) | Extract text from the bound PDF and save it to the given file (UTF-16 LE bytes). |
ExtractText(encoding: Encoding) | Extract text from the bound PDF using the given encoding. |
GetText(outputStream: Stream) | Writes the extracted text as bytes into outputStream, using the encoding set by the most recent ExtractText(Encoding) call (defaults to UTF-16 LE). |
GetText(outputStream: Stream, filterNotAscii: bool) | Writes the extracted text as bytes, optionally dropping non-ASCII codepoints first. |
GetText(outputFile: string) | Writes the extracted text to the given file path. |
HasNextPageText() | True if there is another page’s text available via GetNextPageText. |
GetNextPageText(outputFile: string) | Writes the next page’s text to the given file path (UTF-16 LE bytes). |
GetNextPageText(outputStream: Stream) | Writes the next page’s text to the given stream (UTF-16 LE bytes). |
ExtractImage() | Collects the images of pages StartPage to EndPage (each shared image once) for retrieval with GetNextImage. |
ExtractImage(outputDirectory: string) | Extract every image to the given directory, naming files image_N.jpg for JPEG sources and image_N.png otherwise. |
HasNextImage() | True while GetNextImage(string) has a remaining image to write. |
GetNextImage(outputStream: Stream) | Writes the next extracted image to the stream as JPEG; returns false when no images remain. |
GetNextImage(outputFile: string) | Writes the next extracted image to the given file (JPEG for a .jpg/.jpeg name when the source is JPEG, PNG otherwise); returns false when no images remain. |
GetNextImage(outputStream: Stream, format: System.Drawing.Imaging.ImageFormat) | Calls GetNextImage(outputStream, format) on this PdfExtractor instance. |
GetNextImage(outputFile: string, format: System.Drawing.Imaging.ImageFormat) | Calls GetNextImage(outputFile, format) on this PdfExtractor instance. |
ExtractAttachment() | Select every embedded file in the bound document; a subsequent GetAttachment(string) writes all of them. |
ExtractAttachment(attachmentFileName: string) | Select a single embedded file by name for extraction. |
GetAttachNames() | Names of every embedded file in the bound document. |
GetAttachmentInfo() | FileSpecification entries for every embedded file in the bound document. |
GetAttachment() | Return the selected attachments’ content as MemoryStreams (all attachments when none were explicitly selected). |
GetAttachment(outputPath: string) | Write the selected attachments (all when none were explicitly selected) into the outputPath directory, one file per attachment named after its file name. |
Close() | Releases the bound document (when the extractor opened it) and clears all extraction state. |
Dispose() | Calls Dispose on this PdfExtractor instance. |
