PDFAExportSettings Object (COM-based API)

This object provides functionality for configuring the export of recognized text to PDF/A format. The IPDFAExportSettings interface is a child object of the IOutputFormatSettings interface and inherits all its properties. It is an element of the OutputFormatSettingsCollection collection.

When you save texts that use a non-Latin codepage (say, Cyrillic, Greek, Czech, etc.), ABBYY FineReader Server Open API uses the fonts provided by ParaType company (http://www.paratype.com/store/).

Peculiarities of exporting hieroglyphic languages to PDF/A

You can export hieroglyphic languages to PDF/A in any mode other than PDF Image Only (PDFExportMode = PEM_ImageOnly). For correct depicting of hieroglyphic characters, files for East Asian languages must be installed on all computers where the Processing Station component is installed.

When exporting to PDF/A, the following fonts are used:

  • for the ChineseTraditional recognition language – the PMingLiU font and the MingLiU monospace font;
  • for the ChineseSimplified recognition language – the SimSun font;
  • for the Japanese recognition language – the MS PMincho font and the MS Mincho monospace font;
  • for the Korean recognition language – the Batang font and the BatangChe monospace font.
Properties
Name Type Description
Author String Stores the name of the author of the PDF/A document*. You may set this property to the name of the user. The default value is an empty string.
CreateOutlines Boolean

If this property is set to TRUE, a multi-evel table of contents will be created based on the headings in the recognized document.

Note. If no headings are detected or if there is no recognized text, no table of context will be created.

ColorControlType PictureColorControlTypeEnum

Sets a color mode for output PDF file: Auto, ColorToBwBinary, ColorToGray or SaveColoration.

Note. These settings will be ignored if UseImprovedCompression is TRUE.

DocumentInfo DocumentInfoItems, read-only Stores the metadata from the PDF/A file*.
EnableFastWebView Boolean If this property is set to TRUE, a linearized PDF will be created.
KeepOriginalHeadersFooters Boolean If this property is set to TRUE, original headers and footers will be preserved in the output file. The default value is TRUE.
KeepPictures Boolean Specifies whether to retain pictures.
Keywords String Stores the keywords of the PDF/A document*. The default value is an empty string.
OverwriteMetadata Boolean

Specifies if document metadata (the key-value pairs of the DocumentInfo property and the values of the Title, Author, Subject, Producer, Keywords properties*) must be used instead of the properties of the source document. The default value is FALSE.

Note. If at least one of the Title, Author, Subject, Producer, Keywords, and DocumentInfo properties is changed, this property is automatically set to TRUE.

PaperHeight Long Stores paper height in twips (1/1440 of inch). The default value is the height of A4 format page. See the table "Paper size in different units of measurement". The value of this property is ignored, if the UseOriginalPaperSize property is set to TRUE.
PaperWidth Long Stores paper width in twips (1/1440 of inch). The default value is the width of A4 format page. See the table "Paper size in different units of measurement". The value of this property is ignored, if the UseOriginalPaperSize property is set to TRUE.
PDFExportMode PDFExportModeEnum Specifies the mode of export of recognized text into PDF/A format. It may be: text under the page image (PEM_ImageOnText) and page image only (PEM_ImageOnly). The default value is PEM_ImageOnText.
PDFAMode PDFAModeEnum Specifies the PDF/A standard to be used for the output file.
PDFFontMode BatchPDFFontModeEnum Allows specifying fonts for exported text.
PDFVersion PDFVersionEnum Specifies a PDF version.
PictureResolution Long Stores the value of picture resolution in dpi, which is used for exporting pictures into PDF/A format. This property may be set to -1, which means that the original resolution must be preserved. The default value is 96 dpi.
Producer String Stores the name of the producer of the PDF/A document. The default value is "ABBYY FineReader Server".
ReplaceTextLayerOnlyInPdfs Boolean If this property is set to TRUE, only the text layer will be replaced in input PDF files. All other data will remain unchanged.
Quality Long Stores the value (in percent) of the JPEG quality for color pictures saved in PDF/A format. This value is ignored for black-and-white pictures. The default value is 50%.
Scenario String Specifies the export profile. This may be: BestQuality, MinSize, MaxSpeed or Balanced. The default value is Balanced.
Subject String Stores the subject of the PDF/A document. The default value is an empty string*.
Title String Stores the title of the PDF/A document. The default value is an empty string*.
UseImprovedCompression Boolean

If this property is TRUE, the images in the PDF file will be compressed using Mixed Raster Content (MRC) technology. MRC will provide better compression for some images than the commonly used JPEG method. For example, MRC will better compress good quality images with high-contrast text against a uniform background. Use MRC to reduce the size of the resulting PDF file. The default value is FALSE.

Note. When using MRC on low contrast images with a parti-coloured background artifacts are possible.

UseOriginalPaperSize Boolean If this property is TRUE, original paper size is retained during export to PDF/A format. If the value of this property is FALSE, the paper size specified in the PaperWidth and PaperHeight properties is used. The default value is TRUE.
WriteAnnotations (Obsolete) Boolean Specifies whether to write annotations when creating a PDF file. The default value is TRUE.
PageStamps PageStampCollectionSettings A collection of the stamps to be applied to the output document (headers, footers, watermarks, page numbering, etc.).

* Note. If you change the values of the Author, Keywords, Subject or Title properties the values of the corresponding metadata keys of the DocumentInfo property will be changed or the corresponding key-value pairs will be added to the collection. Vice versa, if the values of the Author, Keywords, Subject or Title keys of the DocumentInfo property are set to some value, the values of the corresponding properties of the PDFAExportSettings object will be set to the same value.

See also

OutputFormatSettings,

OutputFormatSettingsCollection

26.03.2024 13:49:49

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.