FILEEXCELOPTIONS

Summary

The FILEEXCELOPTIONS structure provides information on loading Microsoft Excel 2003 (XLS) and Microsoft Excel 2007 (XLSX/XLSB) files in LEADTOOLS.

Syntax

typedef struct FILEEXCELOPTIONS 
{ 
   L_UINT uStructSize; 
   L_UINT32 uFlags; 
} FILEEXCELOPTIONS, * pFILEEXCELOPTIONS; 

Members

uStructSize

Size of the structure. This must be set before passing this structure to the LEAD functions. Use sizeof(FILEEXCELOPTIONS) to calculate this value.

uFlags

Flag that indicates how Excel files are rendered:

Value Meaning
EXCEL_FLAGS_MULTIPAGE_SHEET [0x00000001] Depending on the current rasterization options set with RASTERIZEDOCOPTIONS, the resulting rendered size of the page can hold more than one sheet. If this flag is set, as many sheets as possible will be rendered on the same page, if the size permits. Otherwise, exactly one sheet per page will be used.
EXCEL_FLAGS_DISABLE_CELL_CLIPPING [0x00000002] If this flag is set, the rendered page width/height chosen by the user will be approximated to the nearest cell width/height to avoid clipping Excel document cells. This means the resulting page's width/height will be either equal to or more than the specified page width/height depending on cell dimensions. This flag has no effect unless EXCEL_FLAGS_MULTIPAGE_SHEET is set.
EXCEL_FLAGS_SHOW_HIDDEN_SHEETS [0x00000004] Render all hidden sheets.
EXCEL_FLAGS_MULTIPAGE_USESHEETWIDTH [0x00000008] Use the full sheet when rasterizing or converting the sheet.
EXCEL_FLAGS_PAGEORDER_DOWNTHENOVER [0x00000010] Cut the sheet into multiple pages by moving from top to bottom first.
EXCEL_FLAGS_MULTIPAGE_ENABLEMARGINS [0x00000020] Consider the margins when rendering a sheet or a page.
EXCEL_FLAGS_SHOWGRIDLINES [0x00000040] When set, the sheet's grid lines will be rendered.

Note If the sheet size is larger than the page size specified by the user, the sheet will be cropped regardless of the setting of this flag.

Comments

pFILEEXCELOPTIONS is a pointer to a FILEEXCELOPTIONS structure.

XLS files have no physical width or height in pixels. Use RASTERIZEDOCOPTIONS to control how the final document is rendered as a raster image.

Usage

Data Types

Functions

Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.