PDFExportFeatures Object (IPDFExportFeatures Interface)

PDFExportFeatures object (IPDFExportFeatures interface) in the ABBYY FineReader Engine API — Additional PDF/PDF/A export parameters (encryption, PDF version, etc.), independent of the chosen export scenario.

This object provides functionality for tuning the additional parameters of export to PDF (PDF/A) format: encryption information, PDF version, etc. These parameters are independent of the chosen export scenario.

Properties

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
Common Settings
FontEmbeddingMode	FontEmbeddingModeEnum	Specifies whether fonts should be embedded during export to PDF (PDF/A). This parameter can be set to FEM_DontEmbed only if the IPDFExportParams::PDFAComplianceMode is set to PCM_None. If for a Chinese-language document the PMingLiU/MingLiU font is used, it will be embedded into output PDF file regardless of the value of this property. The default value of this property is FEM_Auto.
WriteTaggedPDF	ThreeStatePropertyValueEnum	Specifies if the recognized text should be exported to tagged PDF. Tagged PDF is a particular use of structured PDF that allows page content to be extracted and used for various purposes such as reflow of text and graphics, conversion to file formats such as HTML and XML, and accessibility to the visually impaired. The exported PDF may contain tags: <DIV> (division elements) <P> (paragraphs) <SPAN> (entry elements) <L> (list elements, list item elements, list item body elements etc) <Caption> (signatures) <Figure> (images) <Link> (external links) <InternalLink> (internal links) <Lbl> (numerators and markers) <RunningTitle> (running titles) <Note> (note entry elements) <Footnote> (explanatory text elements) <Reference> (reference entry elements). Moreover, the paragraphs with different languages will be split into text fragments with the <SPAN> tags. Each <SPAN> tag contains single language text. Some constraints are imposed on the value of this property: This property can be set to TSPV_Yes only if the PDF version (the PDFVersion property) is 1.4 or higher. PDF/A-1a, PDF/A-2a, and PDF/A-3a are always tagged, so this property cannot be set to TSPV_No if IPDFExportParams::PDFAComplianceMode is set to PCM_Pdfa_1a, PCM_Pdfa_2a, or PCM_Pdfa_3a. This property is TSPV_Auto by default.
ReplaceUncertainWordsWithImage	VARIANT_BOOL	Specifies if uncertainly recognized words should be replaced with their images during export to PDF (PDF/A) format. You may use this property when the IPDFExportParams::TextExportMode property is set to PEM_TextWithPictures or PEM_TextOnImage; otherwise, its value is ignored. This property is FALSE by default.
WriteRunningTitles	VARIANT_BOOL	Specifies whether the running titles should be saved to an output PDF (PDF/A) file. This property is TRUE by default.
WriteLinks	VARIANT_BOOL	Specifies if the hyperlinks must be retained during export of the recognized text to PDF (PDF/A) format. If this property is FALSE the hyperlinks are exported as text. Even if the file was exported with this property set to FALSE, sometimes you can still see the hyperlinks. This is because most PDF viewers detect obvious hyperlinks (text like www​.some-website.net) even if there is no information about them in the PDF file. To disable this feature in Adobe PDF viewers, go to Preferences > General and turn off the Create links from URLs flag. This property is TRUE by default.
EnableLinearization	VARIANT_BOOL	Specifies whether a linearized PDF file should be created. Linearized PDF files have internal data arranged in a page order. A page of a linearized PDF file can be read in a web browser plug-in without waiting for the whole file to be downloaded. Non-linearized PDFs have the data necessary to assemble a document page scattered through the whole file. Non-linearized PDF files are smaller, but they are slower to access. This property makes sense only for multi-page PDF files. If the property is set to TRUE and a one-page document is exported, a non-linearized file is created. This property is FALSE by default.
PageOrientation	PageOrientationEnum	Specifies page orientation during export in PDF format. If the IPaperSizeParams::PaperSizeMode property is set to: PSM_ImageSize or PSM_SynthesisSize, the default value is used. PSM_UserDefined, PSM_AutoFlexible, PSM_AutoFixed, the page orientation is set in compliance with the specified value. By default, the property is set to POM_Auto.
PaperSizeParams	PaperSizeParams, read-only	Specifies paper height and width during export to PDF (PDF/A) format.
ReferenceTimeZone	TimeZoneTypeEnum	Specifies the time zone for the date and time written to the output PDF. This property is TZT_UTC by default.
TextAndBackgroundColorMode	TextAndBackgroundColorModeEnum	Specifies if the original colors of the text and background must be retained during export of the recognized text into PDF format. This property makes sense only if the IPDFExportParams::TextExportMode property is set to PEM_TextOnly, PEM_TextWithPictures or PEM_TextOnImage; otherwise, its value is ignored. The text color can be retained during export only if the ISynthesisParamsForPage::DetectTextColor property was set to TSPV_Yes or TSPV_Auto during page synthesis. The background color can be retained during export only if the ISynthesisParamsForPage::DetectBackgroundColor property was set to TSPV_Yes or TSPV_Auto during page synthesis. This property is TBCM_Auto by default.
Encryption and PDF version
EncryptionInfo	PDFEncryptionInfo, read-only	Specifies encryption parameters of the PDF file. These parameters are used (the IPDFEncryptionInfo::IsEncryptionRequested property can be set to TRUE), only if the IPDFExportParams::PDFAComplianceMode is set to PCM_None.
PDFVersion	PDFVersionEnum	Specifies the version of the PDF (PDF/A) file. Note that the version should not conflict with the specified export parameters. The earliest version of the PDF file which matches the specified parameters of export should be selected as the version of the PDF file: The earliest file version available is 1.3. The PDF file version should be 1.4, if: the PDFAComplianceMode property of the PDFExportParams object is PCM_Pdfa_1a or PCM_Pdfa_1b The PDF file version should be 1.4 or higher, if: at least one of the PermissionFillFormFields, PermissionExtractTextAndGraphicsExt, PermissionAssembleDoc, PermissionPrintExt properties of the PDFEncryptionInfo object is TRUE, or the encryption key length exceeds 40 bits (see the KeyLength property of the PDFEncryptionInfo object), or the WriteTaggedPDF property is TSPV_Yes, or the WriteXmpMetadata property is TSPV_Yes, or the BwPictureFormats property of the PDFPictureCompressionParams is BWPF_JBIG2 or BWPF_JBIG2Lossless. The version should be 1.5 or higher, if the ColorPictureFormats property of the PDFPictureCompressionParams is CPF_J2K, or the GrayPictureFormats property of the PDFPictureCompressionParams is GPF_J2K. The version should be 1.6 or higher, if: the EncryptionAlgorithm property of the PDFEncryptionInfo object is PDFEA_AES128, or OpenType fonts are used in output PDF file. The version should be 1.7 or higher, if: the EncryptionAlgorithm property of the PDFEncryptionInfo object is PDFEA_AES256. The latest file version available is 2.0. The default value of this property is PVN_Auto which specifies that the version is detected automatically.
Metadata writing
MetaDataWritingParams	DocumentContentInfoWritingParams, read-only	Specifies if the author, subject, title, keywords, producer, and creator of the document should be written into the output PDF (PDF/A) file. These parameters of the document are defined in the DocumentContentInfo subobject of the FRDocument object.
WriteXmpMetadata	ThreeStatePropertyValueEnum	Specifies whether document content information should be written to XMP data of the PDF (PDF/A) file. The metadata tags written to XMP are those from the Dublin Core set. Extensible Metadata Platform (XMP) is a technology which allows embedding metadata directly into a file. It simplifies content information extraction for third-party applications. Some constraints are imposed on the value of this property: This property makes sense only for PDF files, because for PDF/A files document content information is always duplicated to XMP in compliance with the standard. Therefore this property can be set to TSPV_No only if the IPDFExportParams::PDFAComplianceMode is set to PCM_None. This property can be set to TSPV_Yes, only if PDF version (the PDFVersion property) is 1.4 or higher. This property is TSPV_Auto by default, which means that metadata should be written to XMP for PDF/A files, and should not be written for PDF files.
Retaining data from the source file
WriteSourceOutline	VARIANT_BOOL	Specifies if the outline of the original PDF/DOCX/RTF/ODT/HTML file should be written to the output file. This property is TRUE by default. If the ExportFileWriter object is used, this property value is ignored and the outline is not written to the output.
WriteSourceAttachments	VARIANT_BOOL Specifies if PDF attachments of the document should be written to the output file. The attachments can originate from the input PDF file or be added to the document via the IFRDocument::PDFAttachments property. You can save attachments only when exporting to PDF/A-3 or non-PDF/A-compliant PDF (PCM_None, PCM_Pdfa_3a, PCM_Pdfa_3b, PCM_Pdfa_3u). This property is FALSE by default.
Compliance
EnableZugferdCompliance	VARIANT_BOOL	Specifies whether the output PDF file is compliant with the ZUGFeRD e-invoice standard. Setting this property to TRUE requires the following: PDF/A-3 compliant document: PDFExportParams::PDFAComplianceMode must be set to PCM_Pdfa_3a, PCM_Pdfa_3b, or PCM_Pdfa_3u Writing PDF attachments enabled: PDFExportFeatures::WriteSourceAttachments must be set to TRUE See ZUGFeRD-compliant electronic invoices for details. This property is FALSE by default.
EnablePDFUACompliance	VARIANT_BOOL	Specifies whether the output PDF file is compliant with the PDF/UA International Standard. This property can be set to TRUE only if WriteTaggedPDF and WriteXmpMetadata properties of the PdfExportFeatures object are set to TSPV_Yes. This property is FALSE by default.

Related objects

Object Diagram

See also

Tuning Export Parameters

Working with Profiles

Working with Properties