TableToText (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
Limit

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableToText (Function)

In french: TableVersTexte

Creates a character string from the data found in a Table or TreeView Table control. This string can be saved in a specific format thereafter.

Example

sText is string
sText = TableToText(TABLE_TABLE1, taNoTitle, ";")
fSaveText("Export.csv", sText)

Syntax

<Result> = TableToText(<Table control> [, <Options> [, <Column separator> [, <Row separator> [, <Start row> [, <End row>]]]]])

<Result>: Character string

Character string containing the data of the Table control. In this string, the columns are separated by <Separator> and the rows are separated by CR characters (Carriage Return).
Empty string ("") if an error occurs or if the Table control is empty

<Table control>: Control name

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

<Options>: Optional constant

Configures the information that must be taken into account in the string.
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.
taNoTitle Only the data is copied.
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).
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".

<Column separator>: Optional character string

Separator used between the columns. The default separator is the tabulation (TAB).

<Row separator>: Optional character string

Separator used between the rows. The separator used by default is the CR character (Carriage Return).

<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

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

Limit

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.

Component: wd300std.dll