XLExportParams Object (IXLExportParams Interface)
This object provides functionality for tuning parameters of recognized text export in XLS/XLSX format. 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. For more information about the default value of this or that property, see the description of the corresponding property.
The XLExportParams object is a persistent object. This means that the object's current state can be written to persistent storage: an area in the global memory or a disk file. Later, the object can be re-created by reading the object's state from persistent storage. The following methods provide persistence of the object: SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.
Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| Format settings | ||
| XLFileFormat | XLFileFormatEnum |
This property determines how recognized text will be exported to XLS format. It may be set to MS Excel 5, MS Excel 8, or both. The value of this property is ignored when exporting to XLSX format. This property is XLFF_DoubleStream by default. |
| LayoutRetentionMode | XLSXLayoutRetentionModeEnum |
This property allows you to set the mode of retaining the original document tables’ layout while exporting to XLSX format. If you change the value of this property to a non-default constant, the TablesOnly, RemoveFormatting, OnePagePerWorksheet, WriteRunningTitles properties are ignored. If you are exporting to XLS format, only the default value of this property is allowed. The default value of this property is XLLRM_Default. |
| TablesOnly | VARIANT_BOOL |
When this property is TRUE, only recognized text from table blocks is exported into XLS/XLSX format. This property is ignored if the LayoutRetentionMode property is equal to XLLRM_ExactDocument or XLLRM_ExactLines. The default for it is FALSE. |
| RemoveFormatting | VARIANT_BOOL |
This property set to TRUE tells ABBYY FineReader Engine to remove formatting for the text exported in XLS/XLSX format. This property is ignored if the LayoutRetentionMode property is equal to XLLRM_ExactDocument or XLLRM_ExactLines. This property is FALSE by default. |
| OnePagePerWorksheet | VARIANT_BOOL |
Specifies if each page of the document is to be exported to a separate worksheet of XLSX file. This property is ignored if the LayoutRetentionMode property is equal to XLLRM_ExactDocument or XLLRM_ExactLines. This property is FALSE by default. |
| ConvertStringsToNumbers | VARIANT_BOOL |
Specifies if numerical values in recognized text are exported to XLS/XLSX format as numbers rather than as strings. This property is TRUE by default. |
| WriteRunningTitles | VARIANT_BOOL |
Specifies whether the running titles should be saved to output XLS/XLSX file. This property is ignored if the LayoutRetentionMode property is equal to XLLRM_ExactDocument or XLLRM_ExactLines. This property is TRUE by default. |
| MetaDataWritingParams | DocumentContentInfoWritingParams, read-only | Specifies if the author, subject, title, and keywords of the document should be written into the output file. These parameters of the document are defined in the DocumentContentInfo subobject of the FRDocument object. |
| CreateRtlSheets | VARIANT_BOOL |
Specifies whether to use right-to-left worksheet direction in exported documents. This property is FALSE by default. |
| Color settings | ||
| KeepTextColor | VARIANT_BOOL |
Specifies if original colors of text are retained during export of the recognized text to XLSX format.
This property is FALSE by default. |
| BackgroundColorMode | BackgroundColorModeEnum |
Specifies the mode of background color saving when exporting to XLSX format. Only table cells background color can be saved. The background color of the text outside tables is not saved regardless of the value of this property.
This property is BCM_DontSave by default. |
| Page size and orientation | ||
| PageOrientation | PageOrientationEnum |
Specifies page orientation during export in XLSX format. The value of this property is ignored, if the PaperSize property is XLPS_NotSpecified. By default, the property is set to POM_Auto.
|
| PaperSize | XLSXPaperSizeEnum |
Specifies one of the standard paper sizes for XLSX file. If this property is XLPS_NotSpecified, the value of the PageOrientation property is ignored. By default, the value of this property is XLPS_NotSpecified. |
| Picture embedding | ||
| WritePictures | VARIANT_BOOL |
Specifies whether pictures must be written in files in XLSX format. This property may be set to TRUE only if the LayoutRetentionMode property is equal to XLLRM_Default. If the LayoutRetentionMode property is set to XLLRM_ExactDocument or XLLRM_ExactLines, pictures will be written into the output file automatically. The default value is FALSE.
|
| PictureExportParams | PictureExportParams, read-only |
Specifies the image format and JPEG quality which should be used for embedded pictures in the output file.
|
Methods
| Name | Description |
|---|---|
| CopyFrom | Initializes properties of the current object with values of similar properties of another object. |
| LoadFromFile | Restores the object contents from a file on disk. |
| LoadFromMemory | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory | Saves the object contents into the global memory. |
Related objects
Output parameter
This object is the output parameter of the CreateXLExportParams method of the Engine object.
Input parameter
This object is passed as the input parameter to the following methods:
- Export, ExportPages, ExportToMemory methods of the FRDocument object
- Export method of the FRPage object
- RecognizeImageFile method of the Engine object
- OnExportPages, OnSendToPages method of the IDocumentViewerEvents interface
Samples
The object is used in the following code samples: CommandLineInterface.
See also
17.09.2024 15:14:40