TableToWord (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Table functions

Use conditions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableToWord (Function)

In french: TableVersWord

Creates a Word file (.RTF) from the data found in a Table or TreeView Table control.

Remark: This file can be opened in Word or OpenOffice Writer (depending on the software installed on the current computer).

Example

sFile is string
// Asks for the file name
sFile = fSelect("", "", "Choose the export file", ...
"Word files (*.rtf) *.rtf", "rtf", 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)

sFile is string
// Asks for the file name
sFile = CompleteDir(fExeDir()) + "MyDOCS" + ConnectionCount() + ".doc"
// 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

<Result> = TableToWord(<Table control> , <Doc file name> [, <Options> [, <Start row> [, <End row>]]])

<Result>: Boolean

True if the file was created,
False otherwise.

<Table control>: Control name

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

<Doc file name>: Character string

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

<Options>: Optional Integer constant

Configures the Word 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.
taNoTitle Only the data is copied to the file.
taNoTotal Does not export:
the rows containing totals, mean and automatic count (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).
This constant is not available.
taWithInvisibleColumns Also exports the invisible control columns.
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".

<Start row>: Optional integer

Number of the row where the export will start. If this parameter is not specified, the start row is the first row of the control.

<End row>: Optional integer

Number of the row where the export will end. If this parameter is not specified, the end row is the last row of the control.

Remarks

Use conditions

TableToWord can be used on:

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

The created file can be opened by Word 95 (or later) or by OpenOffice Writer 2 (or later).
The merged columns are ignored.

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: wd300std.dll