TextLayerInjectionParams Object (ITextLayerInjectionParams Interface)

This object allows you to tune the parameters of processing the input "image only" or "image on text" PDF files while creating a searchable PDF file with the help of the InjectTextLayer method of the Engine object. The properties of a newly created object of this type are set to reasonable defaults (see the properties description).

Properties

Name Type Description
Application Engine, read-only Returns the Engine object.
AllowChangePDFAView VARIANT_BOOL Specifies whether to change the appearance of the output PDF file in case of problems during its processing.

This property is FALSE by default, which means whenever the document is invalid, you will get the FREN_E_PDFA_CONVERSION_FAILED return code, and the document processing will be canceled.
If this property is TRUE, a warning about changing the appearance of the output will be displayed. Use the IProcessingEvents callback to manage the document processing.
PDFAComplianceMode PDFAComplianceModeEnum

Specifies the PDF/A standard compliance for the output PDF file.

This property is PCM_None by default, which means that the output file inherits the PDF/A standard compliance from the original document.

PerformRecognition VARIANT_BOOL

Specifies whether the document processing should be performed during text layer injection.

This property is TRUE by default. If this property is FALSE, the original document will be converted without text layer injection.

WriteCorrectedImage VARIANT_BOOL

Specifies if skew and orientation correction should be performed on the original document. When this property is set to TRUE, the final document will contain the corrected image.

Note: This property is available only if the CorrectOrientation property of the PagePreprocessingParams object is set to TRUE. Otherwise, skew and orientation will not be corrected.

This property is FALSE by default.

WriteTaggedPDF VARIANT_BOOL

Specifies if the resulting PDF document should be tagged.

Note: 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.

Important! This property must be set to TRUE:

  • if PDFAComplianceMode property is set to PCM_Pdfa_1a, PCM_Pdfa_2a, or PCM_Pdfa_3a, because PDF/A-1a, PDF/A-2a, and PDF/A-3a are always tagged.
  • if PDFAComplianceMode property is set to PCM_None by default, but PCM_Pdfa_1a, PCM_Pdfa_2a, or PCM_Pdfa_3a are passed as an input parameters.

The default value of this property is FALSE. However, if the source PDF file is tagged, the value of this property is ignored, and the resulting PDF file is always tagged.

Output parameter

This object is the output parameter of the CreateTextLayerInjectionParams method of the Engine object.

Input parameter

This object is passed as an input parameter to the InjectTextLayer method of the Engine object.

See also

Working with Profiles

24.03.2023 8:51:52

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.