OutputFormatSettings Object (COM-based API)

This object provides functionality for configuring export parameters for recognized text. It may be typecast to one of its child objects:

These objects provide access to the export parameters of different formats and inherit all the properties of the OutputFormatSettings object. They are also elements of the OutputFormatSettingsCollection collection.

Properties
Name Type Description
FileFormat OutputFileFormatEnum, read-only Specifies the output file format.
NamingRule String

Specifies the file naming and output path rule. The rule can contain the elements from the list below in angle brackets <>. The other elements must be typed without angle brackets. The elements without angle brackets will be passed as is. Only one slash is allowed to specify a subfolder in the Output Folder.

The list of file naming and output path elements which can be added to the rule in angle brackets:

  • Dd

Input image day of month

  • Ext

Output format extension

  • FileName

Input image name

  • Folder

Input image folder (if available in the Input Folder)

  • ImageExt

Input image extension

  • Mm

Input image month

  • Time

Input image time

  • Yy

Input image year (2 digits)

  • Yyyy

Input image year (4 digits)

  • Barcode

The barcode value.

For example,

    • <Barcode>.<Ext>
      The barcode value is used as the name of the output file.
    • <Barcode>\<FileName>.<Ext>
      The barcode value is used as the name of the folder. This is useful for sorting documents based on barcode values.
    • <Filename>.<ImageExt>.<Ext>
      The input image extension is preserved in the output file name.
    • OCR_<FileName>.<Ext>
      The prefix "OCR_" is added to the output file name.

The default value is <FileName>.<Ext>.

KeepLastModifiedDate Boolean Specifies whether the date when the image file was modified must be retained when exporting the data. The default value is FALSE.
OutputLocation String Specifies the path to the output location (a shared folder, e-mail addresses, or a folder in the SharePoint document library, according to the value of the PublishingMethod property). Multiple e-mail addresses must be separated by commas.
PublishingMethod OutputPublishingMethodEnum Specifies the destination. The default value is OPM_SharedFolder.
SharePointServerUrl String Specifies URL address of the SharePoint server site. This property is used only if the value of the PublishingMethod property is set to OPM_SharePoint.
SharePointDocumentLibrary String Specifies the SharePoint document library. This property is used only if the value of the PublishingMethod property is set to OPM_SharePoint.

SMTPSettings

SMTPSettings

Specifies the parameters for connection with the SMTP e-mail server. This property is used only if the value of the PublishingMethod property is set to OPM_Smtp.

Note. ABBYY FineReader Server only supports SMTP servers that use the PLAIN authentication method.

Id String The ID of the export format.

Output parameter

The OutputFormatSettings object is the output parameter of the IClient::CreateOutputFormatSettingsmethod.

See also

ExportParams

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.