Click or drag to resize

PdfTranslator Class

The PdfTranslator object is a general-purpose object for translating OcrDocuments and their pages into PDF files or streams.
Inheritance Hierarchy
SystemObject
  Atalasoft.OcrPdfTranslator

Namespace:  Atalasoft.Ocr
Assembly:  Atalasoft.dotImage.Ocr (in Atalasoft.dotImage.Ocr.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class PdfTranslator : IForeignTranslator, 
	ITranslator, IPerPageTranslator

The PdfTranslator type exposes the following members.

Constructors
  NameDescription
Public methodPdfTranslator
Constructs a new PdfTranslator object.
Public methodPdfTranslator(PdfDocumentType)
Constructs a new PdfTranslator object.
Top
Properties
  NameDescription
Public propertyAuthor
Gets or sets the Author metadata to write in the resulting PDF.
Public propertyAutoPageRotation
Determines if the PDFTranslator will correct page rotation
Public propertyCode exampleBookmarkTree
Gets or sets the PDF bookmark tree that will be used with this document. Default value is null (no tree).
Public propertyClearOcrPageContents
Controls the behavior of the translator with respect to keeping OcrPages in memory.
Public propertyCompressionSelector
This delegate can be used to select a compression type for images in an output PDF file.
Public propertyCreator
Gets or sets the Creator metadata to write in the resulting PDF.
Public propertyDocumentType
Specifies the type of PDF document that will be produced, including PDF-A.
Public propertyEncryptMetadata
Sets or gets a boolean indicating that metadata should be encrypted. Default is false.
Public propertyEnforceWordWidths
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.
Public propertyGenerateDefaultColorProfile
Specifies if the PdfTranslator should try to generate it's default ColorProfiles for images added.
Public propertyGenerateThumbnails
Indicates whether or not the translator will generate thumnail images.
Public propertyJpeg2000CompressionFactor
Sets or gets the compression factor for Jpeg2000 images
Public propertyJpegQuality
Sets or gets the JpegQuality that will be used for images compressed with Jpeg.
Public propertyKeywords
Gets or sets the Keywords metadata to write in the resulting PDF.
Public propertyMetadata
Document metadata for the output file
Public propertyOutputType
The output style for pages.
Public propertyOwnerPassword
Sets or gets an owner password to use for the document. Default value is null (no password).
Public propertyPermissions
Sets or gets the set of allowable actions for this PDF.
Public propertyProducer
Gets or sets the Producer metadata to write in the resulting PDF.
Public propertySetDocumentMetadata
Gets or sets a value indicating if metadata should be included in the document.
Public propertySubject
Gets or sets the Subject metadata to write in the resulting PDF.
Public propertyTempPath
Sets or gets a path to use for temporary files.
Public propertyTextColor
Sets or gets a Color that can be used to override the recognized text color.
Public propertyTitle
Gets or sets the Title metadata to write in the resulting PDF.
Public propertyUseDocumentTextColor
Indicates whether or not the document's text color will be used.
Public propertyUseIForeignTranslatorInterface
Indicates whether or not the PdfTranslator should use the older IForeignTranslator interface or the newer IPerPageTranslator interface
Public propertyUseNormalizedBaseline
Indicates whether or not the translator will attempt to normalize the baseline for a line of text.
Public propertyUserPassword
Sets or gets a user password to use for the document. Default value is null (no password).
Public propertyUseTempFiles
Indicates whether or not temporary files will be used for page images in translation.
Top
Methods
  NameDescription
Public methodCanStream
Indicates whether or not this translator can write to a Stream object
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodFinish
Finish a translation.
Public methodGetHashCode
Serves as the default hash function.
(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.)
Protected methodOnPageConstructing
This method fires the PageConstructing event
Public methodPrepare(OcrEngine, OcrDocument)
Prepares the PdfTranslator for output
Public methodPrepare(OcrEngine, OcrDocument, String, Stream)
Prepares the PdfTranslator for output
Public methodPrepare(OcrEngine, OcrDocument, String, String)
Prepares the PdfTranslator for output
Public methodSupported
Returns an array of strings representing the MIME types supported by this translator.
Public methodSupports
Indicates whether or not this translator supports a given MIME type.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTranslate(OcrEngine, OcrDocument, String, Stream, Object)
Translates an OcrDocument to a new output format writing to the given Stream.
Public methodTranslate(OcrEngine, OcrDocument, String, String, Object)
Translates an OcrDocument to a new output format writing to the given path.
Public methodTranslatePage
Translates an individual page to a PDF page.
Top
Events
  NameDescription
Public eventPageConstructing
This event is used to track when each OcrPage object is about to be translated into a PDF page.
Top
Remarks
Use this translator to create searchable PDF's from any supported OCR engine. Supports the MIME Type "application/pdf".
See Also