> ## 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.

# 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. 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>Format settings</em></p></td></tr><tr><td><p><a name="xlfileformat" /><strong>XLFileFormat</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/xlfileformatenum">XLFileFormatEnum</a></strong></p></td><td><p>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.</p><p>This property is XLFF\_DoubleStream by default.</p></td></tr><tr><td><p><a name="layoutretentionmode" /><strong>LayoutRetentionMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/xlsxlayoutretentionmodeenum">XLSXLayoutRetentionModeEnum</a></strong></p></td><td><p>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 <strong>TablesOnly</strong>, <strong>RemoveFormatting</strong>, <strong>OnePagePerWorksheet</strong>, <strong>WriteRunningTitles</strong> properties are ignored.</p><p>If you are exporting to XLS format, only the default value of this property is allowed.</p><p>The default value of this property is XLLRM\_Default.</p></td></tr><tr><td><p><a name="tablesonly" /><strong>TablesOnly</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>When this property is TRUE, only recognized text from table blocks is exported into XLS/XLSX format.</p><p>This property is ignored if the <strong>LayoutRetentionMode</strong> property is equal to XLLRM\_ExactDocument or XLLRM\_ExactLines.</p><p>The default for it is FALSE.</p></td></tr><tr><td><p><a name="removeformatting" /><strong>RemoveFormatting</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 tells ABBYY FineReader Engine to remove formatting for the text exported in XLS/XLSX format.</p><p>This property is ignored if the <strong>LayoutRetentionMode</strong> property is equal to XLLRM\_ExactDocument or XLLRM\_ExactLines.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="onepageperworksheet" /><strong>OnePagePerWorksheet</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>Specifies if each page of the document is to be exported to a separate worksheet of XLSX file.</p><p>This property is ignored if the <strong>LayoutRetentionMode</strong> property is equal to XLLRM\_ExactDocument or XLLRM\_ExactLines.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="convertstringstonumbers" /><strong>ConvertStringsToNumbers</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>Specifies if numerical values in recognized text are exported to XLS/XLSX format as numbers rather than as strings.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="writerunningtitles" /><strong>WriteRunningTitles</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>Specifies whether the running titles should be saved to output XLS/XLSX file.</p><p>This property is ignored if the <strong>LayoutRetentionMode</strong> property is equal to XLLRM\_ExactDocument or XLLRM\_ExactLines.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="metadatawritingparams" /><strong>MetaDataWritingParams</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/documentcontentinfowritingparams">DocumentContentInfoWritingParams</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 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 <strong><a href="/fine-reader/engine/api-reference/document-related-objects/documentcontentinfo">DocumentContentInfo</a> </strong>subobject of the <strong><a href="/fine-reader/engine/api-reference/document-related-objects/frdocument">FRDocument</a></strong> object.</p></td></tr><tr><td><p><a name="creatertlsheets" /><strong>CreateRtlSheets</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>Specifies whether to use right-to-left worksheet direction in exported documents.</p><p>This property is FALSE by default.</p></td></tr><tr><td colspan="3"><p><em>Color settings</em></p></td></tr><tr><td><p><a name="keeptextcolor" /><strong>KeepTextColor</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>Specifies if original colors of text are retained during export of the recognized text to XLSX format.</p><Note>The text color can be retained during export only if the <a href="/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/synthesisparamsforpage#detecttextcolor">ISynthesisParamsForPage::DetectTextColor</a> property was set to TSPV\_Yes or TSPV\_Auto during page synthesis.</Note><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="backgroundcolormode" /><strong>BackgroundColorMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/backgroundcolormodeenum">BackgroundColorModeEnum</a></strong></p></td><td><p>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.</p><Note>The background color can be retained during export only if the <a href="/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/synthesisparamsforpage#detectbackgroundcolor">ISynthesisParamsForPage::DetectBackgroundColor</a> property was set to TSPV\_Yes or TSPV\_Auto during page synthesis.</Note><p>This property is BCM\_DontSave by default.</p></td></tr><tr><td colspan="3"><p><em>Page size and orientation</em></p></td></tr><tr><td><p><a name="pageorientation" /><strong>PageOrientation</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pageorientationenum">PageOrientationEnum</a></strong></p></td><td><p>Specifies page orientation during export in XLSX format. The value of this property is ignored, if the <strong>PaperSize</strong> property is XLPS\_NotSpecified.</p><p>By default, the property is set to POM\_Auto.</p><Warning>The POM\_MostFrequent constant is not available for this property.</Warning></td></tr><tr><td><p><a name="papersize" /><strong>PaperSize</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/xlsxpapersizeenum">XLSXPaperSizeEnum</a></strong></p></td><td><p>Specifies one of the standard paper sizes for XLSX file. If this property is XLPS\_NotSpecified, the value of the <strong>PageOrientation</strong> property is ignored.</p><p>By default, the value of this property is XLPS\_NotSpecified.</p></td></tr><tr><td colspan="3"><p><em>Picture embedding</em></p></td></tr><tr><td><p><a name="writepictures" /><strong>WritePictures</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>Specifies whether pictures must be written in files in XLSX format.</p><p>This property may be set to TRUE only if the <strong>LayoutRetentionMode</strong> property is equal to XLLRM\_Default. If the <strong>LayoutRetentionMode</strong> property is set to XLLRM\_ExactDocument or XLLRM\_ExactLines, pictures will be written into the output file automatically.</p><p>The default value is FALSE.</p><Warning>Picture embedding is not supported for XLS format.</Warning></td></tr><tr><td><p><a name="pictureexportparams" /><strong>PictureExportParams</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/export-parameters/pictureexportparams">PictureExportParams</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 image format and JPEG quality which should be used for embedded pictures in the output file.</p><Warning>Picture embedding is not supported for XLS format.</Warning></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/B_SRGbkkbQ9YH40E/images/fine-reader/engine/xlexportparams.gif?s=e3940588d2f0bf6bebe00fe7ebd786d1" alt="XLExportParams" width="171" height="89" data-path="images/fine-reader/engine/xlexportparams.gif" />[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/xlexportparams#metadatawritingparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/xlexportparams#pictureexportparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/pictureexportparams)[](/fine-reader/engine/api-reference/parameter-objects/export-parameters/documentcontentinfowritingparams)

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

## Output parameter

This object is the output parameter of the [CreateXLExportParams](/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

The object is used in the following code samples for Linux and Windows: [CommandLineInterface](/fine-reader/engine/guided-tour/samples#commandlineinterface)

## 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)