PdfTranslator Class |
The PdfTranslator object is a general-purpose object for translating
OcrDocuments and their pages into PDF files or streams.
Inheritance HierarchySystemObject
Atalasoft.OcrPdfTranslator
Atalasoft.OcrPdfTranslator
Namespace: Atalasoft.Ocr
Assembly: Atalasoft.dotImage.Ocr (in Atalasoft.dotImage.Ocr.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe PdfTranslator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfTranslator | Constructs a new PdfTranslator object. |
| PdfTranslator(PdfDocumentType) | Constructs a new PdfTranslator object. |
Properties| Name | Description | |
|---|---|---|
 | AdjustPdfVersionAsNeeded |
Gets or sets a value indicating whether to adjust PDF version as needed. If the document is saved using features
that surpass the version of the PDF spec to adhere to specified in PdfVersion, this will automatically
adjust the version to match.
|
| Author | Gets or sets the Author metadata to write in the resulting PDF. |
| AutoPageRotation | Determines if the PDFTranslator will correct page rotation |
 | BookmarkTree | Gets or sets the PDF bookmark tree that will be used with this document. Default value is null (no tree).
|
| ClearOcrPageContents | Controls the behavior of the translator with respect to keeping OcrPages in memory. |
| CompressionSelector | This delegate can be used to select a compression type for images in an output PDF file. |
| Creator | Gets or sets the Creator metadata to write in the resulting PDF. |
| DocumentType | Specifies the type of PDF document that will be produced, including PDF-A. |
| EncryptMetadata | Sets or gets a boolean indicating that metadata should be encrypted. Default is true. |
| EnforceWordWidths | Indicates that the PdfTranslator should apply a horizontal scale to the text in a word to
match the word bounding box as accurately as possible using the font size reported by the OCR engine. |
| GenerateDefaultColorProfile | Specifies if the PdfTranslator should try to generate it's default ColorProfiles for images added.
|
| GenerateThumbnails | Indicates whether or not the translator will generate thumnail images. |
| Jpeg2000CompressionFactor | Sets or gets the compression factor for Jpeg2000 images |
| JpegQuality | Sets or gets the JpegQuality that will be used for images compressed with Jpeg. |
| Keywords | Gets or sets the Keywords metadata to write in the resulting PDF. |
| Metadata | Document metadata for the output file |
| OutputType | The output style for pages. |
| OwnerPassword | Obsolete. Sets or gets an owner password to use for the document. Default value is null (no password). |
| PdfVersion |
Gets or sets the desired PDF version for the output document. Currently, this will accept 2.0 value and values
from 1.0 to 1.7 in increments of 0.1. Other values will be rejected. Defaults to 1.4.
|
| Permissions | Sets or gets the set of allowable actions for this PDF. |
| Producer | Gets or sets the Producer metadata to write in the resulting PDF. |
| SetDocumentMetadata | Gets or sets a value indicating if metadata should be included in the document. |
| Subject | Gets or sets the Subject metadata to write in the resulting PDF. |
| TempPath | Sets or gets a path to use for temporary files. |
| TextColor | Sets or gets a Color that can be used to override the recognized text color. |
| Title | Gets or sets the Title metadata to write in the resulting PDF. |
| UseCompressedObjectStreams | Gets or sets a value indicating whether the PDF document contains compressed object streams. |
| UseDocumentTextColor | Indicates whether or not the document's text color will be used. |
| UseIForeignTranslatorInterface | Indicates whether or not the PdfTranslator should use the older IForeignTranslator interface or the newer
IPerPageTranslator interface |
| UseNormalizedBaseline | Indicates whether or not the translator will attempt to normalize the baseline for a line of text.
|
| UserPassword | Obsolete. Sets or gets a user password to use for the document. Default value is null (no password). |
| UseTempFiles | Indicates whether or not temporary files will be used for page images in translation. |
Methods| Name | Description | |
|---|---|---|
| CanStream | Indicates whether or not this translator can write to a Stream object |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Finish | Finish a translation. |
| 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.) |
| OnPageConstructing | This method fires the PageConstructing event |
| Prepare(OcrEngine, OcrDocument) | Prepares the PdfTranslator for output |
| Prepare(OcrEngine, OcrDocument, String, Stream) | Prepares the PdfTranslator for output |
| Prepare(OcrEngine, OcrDocument, String, String) | Prepares the PdfTranslator for output |
| SetOneTimePasswords |
Sets user and owner passwords and generates one-time keys for saving
encrypted PDF document. Keys will be reset after calling Translate method.
|
| Supported | Returns an array of strings representing the MIME types supported by this translator. |
| Supports | Indicates whether or not this translator supports a given MIME type. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Translate(OcrEngine, OcrDocument, String, Stream, Object) | Translates an OcrDocument to a new output format writing to the given Stream. |
| Translate(OcrEngine, OcrDocument, String, String, Object) | Translates an OcrDocument to a new output format writing to the given path. |
| TranslatePage | Translates an individual page to a PDF page. |
Events| Name | Description | |
|---|---|---|
 | PageConstructing | This event is used to track when each OcrPage object is about to be translated into a PDF page. |
Remarks Use this translator to create searchable PDF's from any supported OCR engine. Supports the MIME Type
"application/pdf".
See Also