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:
- AltoExportSettings
- CSVExportSettings
- DOCXExportSettings
- EPUBExportSettings
- HTMLExportSettings
- InternalFormatExportSettings (does not provide any settings)
- JBig2ExportSettings
- Jpeg2kExportSettings
- JpegExportSettings
- JSONExportSettings (does not provide any settings)
- MSWordExportSettings
- NoConversionExportSettings (does not provide any settings)
- PDFExportSettings
- PDFAExportSettings
- PDFEExportSettings
- PngExportSettings
- PPTXExportSettings
- RTFExportSettings
- TextExportSettings
- TiffExportSettings
- XLExportSettings
- XLSXExportSettings
- XMLExportSettings
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:
Input image day of month
Output format extension
Input image name
Input image folder (if available in the Input Folder)
Input image extension
Input image month
Input image time
Input image year (2 digits)
Input image year (4 digits)
The barcode value. For example,
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 |
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
26.03.2024 13:49:49