> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PDFExportParams Object (IPDFExportParams Interface)

This object provides functionality for tuning the parameters of export of recognized text into PDF (PDF/A) format by means of the ABBYY FineReader Engine export functions. A pointer to this object is passed into the export methods as an input parameter, and thus affects the results of export. All properties of a newly created object of this type are set to reasonable defaults.

We recommend that you tune the parameters in the following order:

1. Set the Scenario property at first. This property optimizes export for some parameters: quality, size of the file, or/and speed of export. When you select the value of this property, the properties of the PDFExportParams object and its subobjects are set to the values suitable for the selected task.

<Note>
  The properties' settings can vary depending on the input data.
</Note>

2. After that, you may customize the additional parameters so that they suit your task the best. See [Tuning Export Parameters](/fine-reader/engine/guided-tour/advanced-techniques/tuning-export-parameters) for details.

<Note>
  Properties of the PDFExportParams object have priority over the properties of its subobjects. This means that if you change the value of some property of the PDFExportParams object, the values of the properties of its subobjects can be automatically rewritten. On the contrary, if you change the value of a property of some subobject, the values of the PDFExportParams properties never change.
</Note>

The PDFExportParams object is a persistent object. This means that the object's current state can be written to persistent storage. Later, the object can be re-created by reading the object's state from the persistent storage. The following methods provide persistence of the object:

Linux: [SaveToFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method), and [LoadFromFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfromfile-method)

Windows [SaveToFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method), [LoadFromFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfromfile-method), [SaveToMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetomemory-method), and [LoadFromMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfrommemory-method).

## Properties

<table><thead><tr><th><p><strong>Name</strong></p></th><th><p><strong>Type</strong></p></th><th><p><strong>Description</strong></p></th></tr></thead><tbody><tr><td><p><strong>Application</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/engine-object-iengine-interface">Engine</a></strong>, <a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">read-only</a></p></td><td><p>Returns the <strong>Engine</strong> object.</p></td></tr><tr><td colspan="3"><p><em>Export scenario</em></p></td></tr><tr><td><p><a name="scenario" /><strong>Scenario</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pdfexportscenarioenum">PDFExportScenarioEnum</a></strong></p></td><td><p>Specifies the scenario of export to PDF (PDF/A) format, which optimizes export for some parameters: quality, size of the file, and/or speed of export.</p><Note>If you change the value of this property, the <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#fontembeddingmode">FontEmbeddingMode</a> , <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#textandbackgroundcolormode">TextAndBackgroundColorMode</a> , <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#writexmpmetadata">WriteXmpMetadata</a> , <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#writetaggedpdf">WriteTaggedPDF</a> properties of the PDFExportFeatures subobject and <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#colorpictureformats">ColorPictureFormats</a> , <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#graypictureformats">GrayPictureFormats</a> , <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#bwpictureformats">BwPictureFormats</a> properties of the PDFPictureCompressionParams subobject are set to their default values.</Note><p>The default value is PES\_Balanced.</p><p>Please note that depending on the chosen scenario some inner export settings can change. This will have influence on the value of the next <strong>PDFExportParams</strong> properties:</p><ul><li><strong>PDFAComplianceMode</strong></li><li><strong>TextExportMode</strong></li><li><strong>MRCMode</strong></li><li><strong>PDFFeatures</strong><ul><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#fontembeddingmode">FontEmbeddingMode</a></strong></li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#writetaggedpdf">WriteTaggedPDF</a></strong></li></ul></li><li><strong>Colority</strong></li><li><strong>CorrectColorDepth</strong></li><li><strong>PictureCompressionParams</strong><ul><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#bwpictureformats">BwPictureFormats</a></strong></li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#colorpictureformats">ColorPictureFormats</a></strong></li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#graypictureformats">GrayPictureFormats</a></strong></li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#jpegquality">JpegQuality</a></strong></li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfmrcparams">MRCParams</a></strong><ul><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfmrcparams#colormaskdownsampling">ColorMaskDownSampling</a></strong></li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfmrcparams#backgrounddownsampling">BackgroundDownSampling</a></strong></li></ul></li></ul></li><li><strong>Resolution</strong></li><li><strong>ResolutionType</strong></li></ul></td></tr><tr><td colspan="3"><p><em>Format settings</em></p></td></tr><tr><td><p><a name="pdfacompliancemode" /><strong>PDFAComplianceMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pdfacompliancemodeenum">PDFAComplianceModeEnum</a></strong></p></td><td><p>Specifies the format of export: PDF, PDF/A-1a, PDF/A-1b, PDF/A-2a, PDF/A-2b, PDF/A-2u, PDF/A-3a, PDF/A-3b, or PDF/A-3u.</p><p>The value of this property affects the settings that can be used during export. If the value of this property is not PCM\_None (export to PDF/A format is performed):</p><ul><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfencryptioninfo#isencryptionrequested">IsEncryptionRequested</a></strong> property of the <strong>PDFEncryptionInfo</strong> subobject cannot be set to TRUE</li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#pdfversion">PDFVersion</a></strong> property of the <strong>PDFExportFeatures</strong> subobject can be set only to PVN\_Auto or PVN\_Version14 for PDF/A-1a, PDF/A-1b</li><li>If the format is PDF/A-1a, PDF/A-2a, or PDF/A-3a, the <strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#writetaggedpdf">WriteTaggedPDF</a></strong> property of the <strong>PDFExportFeatures</strong> subobject cannot be set to TSPV\_No (the file is always tagged)</li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#writexmpmetadata">WriteXmpMetadata</a></strong> property of the <strong>PDFExportFeatures</strong> subobject cannot be set to TSPV\_No</li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#fontembeddingmode">FontEmbeddingMode</a> </strong>property of the <strong>PDFExportFeatures</strong> subobject cannot be set to FEM\_DontEmbed</li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#colorpictureformats">ColorPictureFormats</a></strong> property of the <strong>PDFPictureCompressionParams </strong>subobject cannot be set to CPF\_J2K (for PDF/A-1a, PDF/A-1b only) or CPF\_LZW</li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams#graypictureformats">GrayPictureFormats</a> </strong>property of the <strong>PDFPictureCompressionParams </strong>subobject cannot be set to GPF\_J2K (for PDF/A-1a, PDF/A-1b only) or GPF\_LZW</li><li><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures#writesourceattachments">WriteSourceAttachments</a></strong> property of the <strong>PDFExportFeatures</strong> subobject cannot be set to TRUE for PDF/A-1a, PDF/A-1b, PDF/A-2a, PDF/A-2b, PDF/A-2u.</li></ul><p>If these requirements are not met, an error is returned.</p><p>By default, the value is PCM\_None, which means that export to PDF should be performed.</p></td></tr><tr><td><p><a name="textexportmode" /><strong>TextExportMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pdfexportmodeenum">PDFExportModeEnum</a></strong></p></td><td><p>Specifies the mode of export of recognized text into PDF (PDF/A) format. It may be: text and pictures only, text over the page image, text under the page image, page image only, text only.</p><Note>If this property is PEM\_TextOnly, the values of the BwPictureFormats , ColorPictureFormats , and GrayPictureFormats properties of the <a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams">PDFPictureCompressionParams</a> subobject are ignored.</Note><p>This property is PEM\_ImageOnText by default.</p></td></tr><tr><td><p><a name="mrcmode" /><strong>MRCMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pdfmrcmodeenum">PDFMRCModeEnum</a></strong></p></td><td><p>Specifies the mode of using <strong><a href="/fine-reader/engine/api-reference/enumerations/pdfmrcmodeenum">Mixed Raster Content</a></strong> for output PDF (PDF/A) file.</p><Note>The value of this property is ignored during export to black-and-white PDF.</Note><p>By default, the value of this property is MRC\_Auto.</p></td></tr><tr><td><p><a name="pdffeatures" /><strong>PDFFeatures</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures">PDFExportFeatures</a></strong>, <a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">read-only</a></p></td><td><p>Specifies the additional export parameters: encryption information, PDF version, etc.</p></td></tr><tr><td colspan="3"><p><em>Color settings</em></p></td></tr><tr><td><p><a name="colority" /><strong>Colority</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/picturecoloritymodeenum">PictureColorityModeEnum</a></strong></p></td><td><p>Allows you to keep color of the output PDF (PDF/A) file or save it in gray or black-and-white. It may be useful to set this property to PCM\_ForceToGray for color documents, if you do not need to save their colors and want to reduce the size of output files.</p><Note>If the CorrectColorDepth property is set to TRUE, ABBYY FineReader Engine can additionally correct color depth of the document. For example, if you set Colority to PCM\_ForceToGray and CorrectColorDepth is TRUE, FineReader Engine will change the color images to gray, then will detect color depth of gray images and, if necessary, will change some images to black-and-white.</Note><p>The default value for this property is PCM\_KeepColority.</p></td></tr><tr><td><p><a name="correctcolordepth" /><strong>CorrectColorDepth</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE enables ABBYY FineReader Engine to correct color depth of the document. If you set the property to FALSE, ABBYY FineReader Engine will save colors of the document as defined in the <strong>Colority</strong> property.</p><p>By default, the value of this property is TRUE.</p></td></tr><tr><td colspan="3"><p><em>Picture settings</em></p></td></tr><tr><td><p><a name="pdfpictures" /><strong>PDFPictures</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpictures">PDFPictures</a></strong></p></td><td><p>Returns the collection of the user-defined images attached to the output PDF file. To add an image to this collection, use the <strong><a href="/fine-reader/engine/api-reference/supplementary-objects-and-methods/addnew-method">AddNew</a></strong> method of the <strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpictures">PDFPictures</a></strong> object and set the image position on a page by the methods of the <strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicture">PDFPicture</a></strong> object.</p></td></tr><tr><td><p><a name="picturecompressionparams" /><strong>PictureCompressionParams</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams">PDFPictureCompressionParams</a></strong>, <a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">read-only</a></p></td><td><p>Specifies the parameters of writing images to PDF (PDF/A) files, including MRC parameters. These parameters allow you to reset the parameters defined in the chosen export scenario.</p></td></tr><tr><td><p><a name="resolution" /><strong>Resolution</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">int</a></strong></p></td><td><p>Specifies the picture resolution in dpi. The <strong>ResolutionType</strong> property specifies how the value of this property must be interpreted.</p><Note>The specified resolution cannot be higher than the original resolution.</Note><p>The default value for the property is 300 dpi.</p></td></tr><tr><td><p><a name="resolutiontype" /><strong>ResolutionType</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pdfresolutiontypeenum">PDFResolutionTypeEnum</a></strong></p></td><td><p>Defines how to use the value of the picture resolution specified in the <strong>Resolution</strong> property. It may be used:</p><ul><li>as the absolute resolution (used for all pictures),</li><li>as the desired resolution (may be used only if the original resolution is above the desired, the program selects optimal dpi value nearest to the desired resolution),</li><li>or the value is ignored (and the original resolution is used).</li></ul><p>By default, the value of this property is PRT\_Desired.</p></td></tr></tbody></table>

## Methods

| Name                                                                                                                                               | Description                                                                                       |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| [CopyFrom](/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method)                              | Initializes properties of the current object with values of similar properties of another object. |
| [LoadFromFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfromfile-method)                                            | Restores the object contents from a file on disk.                                                 |
| [LoadFromMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfrommemory-method) <br /><br /> **Note:** *Windows only.* | Restores the object contents from the global memory.                                              |
| [SaveToFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method)                                                | Saves the object contents into a file on disk.                                                    |
| [SaveToMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetomemory-method) <br /><br /> **Note:** *Windows only.*     | Saves the object contents into the global memory.                                                 |

## Related objects

<img src="https://mintcdn.com/abbyy/i-EfCQVmseNiPQcp/images/fine-reader/engine/pdfexportparams.gif?s=278fb5d8dd757678be80c38fba148e27" alt="PDFExportParams" width="188" height="265" data-path="images/fine-reader/engine/pdfexportparams.gif" />[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicture)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpictures)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pictureresolutionparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfmrcparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfpicturecompressionparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/papersizeparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/documentcontentinfowritingparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfencryptioninfo)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pdfexportfeatures)

[Object Diagram](/fine-reader/engine/api-reference/object-diagram)

## Output parameter

This object is the output parameter of the [CreatePDFExportParams](/fine-reader/engine/api-reference/engine-object-iengine-interface/creation-methods/createlessobjectgreater-methods) method of the [Engine](/fine-reader/engine/api-reference/engine-object-iengine-interface) object.

## Input parameter

This object is passed as the input parameter to the following methods:

* [Export](/fine-reader/engine/api-reference/document-related-objects/frdocument/export-method), [ExportPages](/fine-reader/engine/api-reference/document-related-objects/frdocument/exportpages-method), [ExportToMemory](/fine-reader/engine/api-reference/document-related-objects/frdocument/exporttomemory-method) methods of the [FRDocument](/fine-reader/engine/api-reference/document-related-objects/frdocument) object

* [Export](/fine-reader/engine/api-reference/document-related-objects/frpage/export-method) method of the [FRPage](/fine-reader/engine/api-reference/document-related-objects/frpage) object

* [RecognizeImageFile](/fine-reader/engine/api-reference/engine-object-iengine-interface/processing-methods/recognizeimagefile-method) method of the [Engine](/fine-reader/engine/api-reference/engine-object-iengine-interface) object

* [OnExportPages](/fine-reader/engine/visual-components-reference/idocumentviewerevents/onexportpages-method) method of the [IDocumentViewerEvents](/fine-reader/engine/visual-components-reference/idocumentviewerevents) interface for Windows Visual Components

* [OnSendToPages](/fine-reader/engine/visual-components-reference/idocumentviewerevents/onsendtopages-method) method of the [IDocumentViewerEvents](/fine-reader/engine/visual-components-reference/idocumentviewerevents) interface for Windows Visual Components

## Samples

<Accordion title="C# code">
  ```csharp theme={null}
  FREngine.IEngine engine;
  FREngine.IFRDocument frDocument;
  // We presume that the document has been recognized and synthesized
  // Tune parameters of export
  FREngine.IPDFExportParams pdfParams = Engine.CreatePDFExportParams();
  pdfParams.Scenario = FREngine.PDFExportScenarioEnum.PES_Balanced;
  // Save results using specified parameters
  frDocument.Export( "D:\\Demo.pdf", FREngine.FileExportFormatEnum.FEF_PDF, pdfParams );
  ```
</Accordion>

The object is used in the following code samples:

* Linux: [Hello](/fine-reader/engine/guided-tour/samples#hello), [CommandLineInterface](/fine-reader/engine/guided-tour/samples#commandlineinterface)
* macOS: [TiffToRtf](/fine-reader/engine/guided-tour/samples#tifftortf)
* Windows: [Hello](/fine-reader/engine/guided-tour/samples#hello), [CommandLineInterface](/fine-reader/engine/guided-tour/samples#commandlineinterface); and demo tools: [BatchProcessingRecognition](/fine-reader/engine/guided-tour/samples#batchprocessingrecognition), [MultiProcessingRecognition](/fine-reader/engine/guided-tour/samples#multiprocessingrecognition), [PDFExportProfiles](/fine-reader/engine/guided-tour/samples#pdfexportprofiles)

## See also

[Tuning Export Parameters](/fine-reader/engine/guided-tour/advanced-techniques/tuning-export-parameters)

[Working with Profiles](/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles)

[Working with Properties](/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)

[ZUGFeRD-compliant electronic invoices](/fine-reader/engine/guided-tour/advanced-techniques/zugferd-compliant-electronic-invoices)