gARetrieve (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Distinct elements
Combo Box column

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gARetrieve (Function)

In french: gToRetrieve

Warning
From version 27, gARetrieve is kept for backward compatibility. This function is replaced by gARetrieve.

Describes the text value to display and to return when retrieving the value of an element found in a List Box control or in a Combo Box control.

Versions 16 and later

This function is now available for PHP sites.

New in version 16

This function is now available for PHP sites.

This function is now available for PHP sites.

Example

ListDeleteAll(LISTE_Annonce)
ListAdd(LISTE_Annonce, gPen(Black) + "Voiture")
// LISTE_Annonce[1] retourne la chaîne de caractères "Voiture"
ListAdd(LISTE_Annonce, gToRetrieve("Bateau") + gPen(Black) + " à vendre")
// LISTE_Annonce[2] retourne la chaîne de caractères "Bateau"
ListAdd(LISTE_Annonce, gToRetrieve(gImage(2, 25) + "ABC") + "DEF")
// LISTE_Annonce[3] retourne la chaîne de caractères "2,25" + ESC + "ABC"
// Les fonctions gRectangle, gCercle, gLigne sont ignorées
ListAdd(LISTE_Annonce, gToRetrieve(gRectangle(0, 0, 50, 18)))
// LISTE_Annonce[4] retourne une chaîne vide

Syntax

<Result> = gARetrieve(<String to return>)

<Result>: Character string

Control string that must be used in ListAdd, ListInsert or ListModify. Each returned element is separated by the ESC constant.

<String to return>: Character string

Text value to return. Only this parameter will be returned to the language. This parameter will be displayed in the row.
This parameter can contain functions for drawing in the list boxes (starting with the letter "g"). You can:
add drawings to the text,
modify the text formatting (background color, text color, etc.).
The created drawings will also be returned to the language.
The content of the <String to return> can be searched using the ListSeek function.

Remarks

Distinct elements

Are considered as being distinct elements:

two texts separated by gPen or gCoord,
a text and an image.

Each returned element is separated by the ESC constant.

Combo Box column

For the Combo Box columns, the sort depends on the content of the combo box (and not on the subscript of the combo box). Thus, for combos in tables, the content of the combo that will be used as a sorting criterion must be described by the function gARetrieve.

Component: wd270obj.dll