PDFEExportSettings Object (Web Services API)

This object provides functionality for configuring the export of recognized text to PDF/E format. The PDFEExportSettings object is a child object of the OutputFormatSettings object and inherits all its properties.

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/E

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

When exporting to PDF/E, 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
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.

CreateOutlines Boolean

If this property is set to TRUE, a multi-level 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.

DocumentInfo DocumentInfoItem[ ] Stores the metadata from the PDF/E 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.
KeepPictures Boolean Specifies whether to retain pictures.
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.

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

PageStamps PageStampCollectionSettings A collection of the stamps to be applied to the output document (headers, footers, watermarks, page numbering, etc.).
PaperHeight Integer Stores paper height in twips (1/1440 of inch). 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 Integer Stores paper width in twips (1/1440 of inch). 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/E format. It may be: text under the page image (PEM_ImageOnText) and page image only (PEM_ImageOnly).
PDFFontMode BatchPDFFontModeEnum Allows specifying fonts for exported text.
PDFVersion PDFVersionEnum Specifies a PDF version.
PictureResolution Integer Stores the value of picture resolution in dpi, which is used for exporting pictures into PDF/E format. This property may be set to -1, which means that the original resolution must be preserved.
Quality Integer Stores the value (in percent) of the JPEG quality for color pictures saved in PDF/E format. This value is ignored for black-and-white pictures.
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.
Scenario PDFExportScenarioEnum Specifies the export profile. This may be: BestQuality, MinSize or Balanced.
UseOriginalPaperSize Boolean If this property is TRUE, original paper size is retained during export to PDF/E format. If the value of this property is FALSE, the paper size specified in the PaperWidth and PaperHeight properties is used.
WriteAnnotations Boolean Specifies whether to create links for URL and e-mail addresses.

* 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 PDFEExportSettings object will be set to the same value.

See also

OutputFormatSettings

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.