TableToExcel (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Printing in an XLS file

Related examples

See also

TableToExcel (Function)

In french: TableVersExcel

Creates an Excel file with the data from a Table or TreeView Table control.

Remark: This file can be opened by Excel or by OpenOffice Calc (depending on the software installed on the current computer).

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Versions 18 and later

This function can now be used to handle the TreeView Tables in the WEBDEV sites.

New in version 18

This function can now be used to handle the TreeView Tables in the WEBDEV sites.

Versions 23 and later

This function is now available for WEBDEV sites in Linux.

New in version 23

This function is now available for WEBDEV sites in Linux.

Example

sFile is string
// Asks for the file name
sFile = fSelect("", "", "Choose the export file", ...
"Excel files (*.xls) *.xls", "xls", fselCreate + fselExist)
// If the name was not specified, cancels the export
// Otherwise, exports the content of TABLE_TABLE1
IF sFile <> "" THEN TableToWord(TABLE_TABLE1, sFile, taNoTitle)

Syntax

Selecting all rows or the first N rows found in the Table or TreeView Table control Hide the details

<Result> = TableToExcel(<Table control> , <XLS file to create> [, <Options> [, <Number of exported rows>]])

<Result>: Boolean

True if the file was created,
False otherwise. To get more details on the error, use ErrorInfo.

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.

<XLS file to create>: Character strings

Name and full path of Excel file to create. The file is replaced with the new file if it already exists.

<Options>: Optional Integer constant or combination of constants

Configures the XLS file to create.
taColumnDisplayedOrder Exports the columns according to the order of columns currently displayed in the control (and not according to the order of columns defined in the editor).
This constant is not available.
taColumnsTitles
(default value) The title of the columns is inserted in the file.
taMerge If the XLS file already exists, merges the existing content with the new content: the formulas, the formatting, ... of existing cells is kept. The existing data is not stored. Only the data of columns and rows found as well in the existing XLS file is kept.
taNoTitle Only the data is copied into the file.
taNoTotal Does not export:
the rows containing totals, mean and automatic count (these rows are exported by default).
Versions 22 and later
the rows containing custom calculations (these rows are exported by default).
New in version 22
the rows containing custom calculations (these rows are exported by default).
the rows containing custom calculations (these rows are exported by default).
This constant is not available.
taSelectedLines Exports the selected rows only (all the rows are exported by default). Does not export the totals.
taWithInvisibleColumns Also exports the invisible control columns.
Versions 22 and later
The columns defined as non printable and non exportable are exported. These columns are defined:
programmatically: VisibleInExportAndPrint property set to False.
in the "General" tab of the column description window: "Export and print" set to "Never".
New in version 22
The columns defined as non printable and non exportable are exported. These columns are defined:
programmatically: VisibleInExportAndPrint property set to False.
in the "General" tab of the column description window: "Export and print" set to "Never".
The columns defined as non printable and non exportable are exported. These columns are defined:
programmatically: VisibleInExportAndPrint property set to False.
in the "General" tab of the column description window: "Export and print" set to "Never".
taWithLayout Exports the color and the font used in the control.

<Number of exported rows>: Optional integer

Number of rows to export. Only the rows found between 1 and <Number of exported rows> will be exported.
All rows found in the Table control will be exported if this parameter is not specified.

Selecting the rows found in the Table or TreeView Table control Hide the details

<Result> = TableToExcel(<Table control> , <XLS file to create> [, <Options> [, <Start row> [, <End row> [, <Password>]]]])

<Result>: Boolean

True if the file was created,
False otherwise. To get more details on the error, use ErrorInfo.

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.

<XLS file to create>: Character strings

Name and full path of Excel file to create. The file is replaced with the new file if it already exists.

<Options>: Optional Integer constant or combination of constants

Configuration of XLS file to create.
taColumnDisplayedOrder Exports the columns according to the order of columns currently displayed in the control (and not according to the order of columns defined in the editor).
This constant is not available.
taMerge If the XLS file already exists, merges the existing content with the new content: the formulas, the formatting, ... of existing cells is kept.
taNoTitle Only the data is copied into the file.
taNoTotal Does not export:
the rows containing totals, mean and automatic count (these rows are exported by default).
Versions 22 and later
the rows containing custom calculations (these rows are exported by default).
New in version 22
the rows containing custom calculations (these rows are exported by default).
the rows containing custom calculations (these rows are exported by default).
This constant is not available.
taSelectedLines Exports the selected rows only (all the rows are exported by default).
Does not export the totals.
taWithInvisibleColumns Also exports the invisible control columns.
Versions 22 and later
The columns defined as non printable and non exportable are exported. These columns are defined:
programmatically: VisibleInExportAndPrint property set to False.
in the "General" tab of the column description window: "Export and print" set to "Never".
New in version 22
The columns defined as non printable and non exportable are exported. These columns are defined:
programmatically: VisibleInExportAndPrint property set to False.
in the "General" tab of the column description window: "Export and print" set to "Never".
The columns defined as non printable and non exportable are exported. These columns are defined:
programmatically: VisibleInExportAndPrint property set to False.
in the "General" tab of the column description window: "Export and print" set to "Never".
taWithLayout Exports the color and the font used in the control.

<Start row>: Optional integer

Number of the row where the export will start. All the control rows will be exported if this parameter and <End row> are not specified.

<End row>: Optional integer

Number of the row where the export will end. All the control rows will be exported if this parameter and <Start row> are not specified.

<Password>: Optional character string

Versions 24 and later
Password of the generated Excel file (only for XLSX files). This password is required to open the generated Excel file.
New in version 24
Password of the generated Excel file (only for XLSX files). This password is required to open the generated Excel file.
Password of the generated Excel file (only for XLSX files). This password is required to open the generated Excel file.

Remarks

Use conditions

TableToExcel can be used on:

a Table or TreeView Table control based on a data file.
a Table or TreeView Table control populated programmatically.
a single-selection or multi-selection control.

Miscellaneous

The Excel files cannot exceed 65536 rows and 256 columns if the extension used is ".xls". This limit can be exceeded by using the ".xlsx" extension in order to create files in Excel 2007 format. Caution: in this case, the former versions of Excel must be equipped with the "Office 2007 compatibility pack", that can be downloaded from the Microsoft site in order to open the generated documents.
The created file can be opened by Excel 97 (or later) or by OpenOffice Calc 2 (or later).
It is possible to create XLSX files: You just need to specify the extension in the <XLS file to create< parameter.
"High-Precision Numeric" columns (38 significant digits) will be exported as exponential numbers.
The merge operation performed on the Table control columns is ignored.
Unicode columns are exported in Unicode format to Excel.
Check Box columns are exported as Check Boxes.
RTF columns are exported without formatting.
The following elements are not exported into the Excel file:
- The images,
- The charts,
- The bar codes.

Printing in an XLS file

It is possible to print directly in an XLS file:

with the iDestination function,
from the report viewer.

The created XLS file is configured by iParameterXLS.

Related Examples:

Unit examples (WINDEV): The TableTo functions

[ + ] Exporting table data with the WLanguage functions.
The following topics are presented in this example:
1/ interfacing with Word and Excel
2/ sending data to the clipboard
3/ generating a text file
This example explains how to export the content of a table to a Word document, an Excel workbook, the clipboard or a text file via the following WLanguage functions: TableToWord, TableToExcel, ToClipboard, TableToText.

Business / UI classification: UI Code

Component: wd270xls.dll