PDFExportSettings Object (Web Services API)

This object is used for configuring the export of recognized text to PDF. The PDFExportSettings object is a child object of the OutputFormatSettings object and inherits all its properties.

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

Important notes about exporting CJK texts to PDF

You can export texts in CJK languages to PDF in any mode other than image-only PDF (i.e. when PDFExportMode = PEM_ImageOnly). For the correct display of CJK characters, fonts for East Asian languages must be installed on all the computers where the Processing Station component is installed.

When exporting to PDF, the following fonts will be used:

  • for ChineseTraditional, PMingLiU and MingLiU monospace will be used
  • for ChineseSimplified, the SimSun will be used
  • for Japanese, MS PMincho and MS Mincho monospace will be used
  • for Korean, Batang font and BatangChe monospace will be used

Note. The earliest version of the PDF file which matches the specified properties of the PDFEncryptionInfo object is selected as the version of the PDF file.

Properties
Name Type Description
ColorControlType PictureColorControlTypeEnum

Sets a color mode for the 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 contents will be created.

DocumentInfo DocumentInfoItem[ ] Stores the metadata from the PDF file.
EnableFastWebView Boolean If this property is set to TRUE, a linearized PDF will be created.
EncryptionInfo PDFEncryptionInfo Specifies encryption parameters for the PDF file. The property returns a reference to the PDFEncryptionInfo object.
KeepOriginalHeadersFooters Boolean If this property is set to TRUE, the original headers and footers will be preserved in the output file.
KeepPictures Boolean Specifies whether or not 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, and 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 or DocumentInfo properties is changed, this property will be automatically set to TRUE.

PaperStamps PageStampCollectionSettings A collection of stamps to be applied to the output document (i.e. headers, footers, watermarks, page numbering, etc.).
PaperHeight Integer Stores paper height in twips (1/1440 of an inch). The standard paper sizes are listed in the table below. The value of this property will be ignored if the UseOriginalPaperSize property is set to TRUE.
PaperWidth Integer Stores paper width in twips (1/1440 of an inch). The standard paper sizes are listed in the tablle below. The value of this property will be ignored if the UseOriginalPaperSize property is set to TRUE.
PDFExportMode PDFExportModeEnum Specifies the export mode to be used when exporting the recognized text to PDF. The following export modes are available: "text and pictures only," "text over the page image," "text under the page image," and "page image only."
PDFVersion PDFVersionEnum Specifies the version of PDF to be used.
PictureResolution Integer Stores picture resolution in dpi. This value will be used for exporting pictures to PDF. If this property is set to -1, the original picture resolution will be preserved.
Quality Integer Stores JPEG quality for color pictures (in %). This value will be used for exporting color pictures to PDF. 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. All the other data contained in the input PDFs will remain unchanged.
Scenario String Specifies an export profile. The following export profiles are available: "BestQuality,"" MinSize," and "Balanced."
SignatureSettings PDFSignatureSettings Specifies signature parameters for the output PDF file.
UseOriginalPaperSize Boolean If this property is TRUE, the original paper size will be retained when exporting to PDF. If this property is FALSE, the paper size specified in the PaperWidth and PaperHeight properties will be used.
WriteAnnotations Boolean Specifies whether or not 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 also be changed or the corresponding key-value pairs will be added to the collection. Similarly, if the values of the Author, Keywords, Subject or Title keys of the DocumentInfo property have certain values, the values of the corresponding properties of the PDFExportSettings object will also be set to these values.

Paper size in different units of measurement
Paper size in inch in mm in twips (1/1440 of an inch)
A3 11.69 x 16.54 297 x 420 16838 x 23811
A4 8.27 x 11.69 210 x 297 11909 x 16834
A5 5.83 x 8.27 148 x 210 8391 x 11909
Legal 8.5 x 14 216 x 356 12240 x 20160
Letter 8.5 x 11 216 x 279 12240 x 15840
Executive 7.25 x 10.5 184 x 266 10440 x 15120

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.