Referring to an element in a WLanguage event / process

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Common

Referring to an element in a WLanguage event / process

What is an element?

Handling an element

Handling a second-level element

Handling a third-level element

Retrieving the name of an element in the code

See also

Optional events

Referring to an element in a WLanguage event / process

What is an element?

The table below presents the different elements found in an application:

Element	Second-level element	Third-level element

Window	Window controls Window menus Cells of a status bar	Controls belonging to a supercontrol or to a toolbar Menu options Table columns
Page Frameset	Page controls Page menus	Table columns
Report	Report controls Report blocks	Table columns
Query	Query items
Data file	Items of a data file

The menu options and the items found in a data file are handled differently. For more details, see Special case: Items and Special case: Menu options.

Remark: To simplify the writing of WLanguage processes, WINDEV, WEBDEV and WINDEV Mobile allow you to easily retrieve the name of an element in a code window. For more details, see Retrieving the name of an element in the code.

Handling an element

To handle a page, window, report, query or data file in a WLanguage event or process, simply use the name of this element. This name can be used:

in a WLanguage function.
with a WLanguage property.
in direct assignment.

For example:

// Initialisation et exécution de la requête REQ_ListeClient
HExecuteQuery(REQ_ListeClient)

// Modification du nombre d'exemplaires de l'état ETAT_Client
ETAT_Client.NbCopie =10

// Récupération du titre de la fenêtre FEN_FenRecherche
ResTitre is string = FEN_FenRecherche

// Récupération du titre de la page PAGE_PageRecherche
ResTitre is string = PAGE_PageRecherche

Handling a second-level element

To handle a second-level element (control or menu of a window/page, control or block of a report, etc.) in a WLanguage event or process, simply:

use the name of this second-level element directly. This syntax is valid only if this second-level element is handled from the window (or from the report) to which it belongs.
use the following notation: "<ElementName>.<Name2ndLevelElement>".

A second-level element can be handled:

in a WLanguage function.
with a WLanguage property.
in direct assignment.

For example:

// Déroule la liste du champ Combo COMBO_VilleFrance
// de la fenêtre FEN_Client
ComboOpen(COMBO_VilleFrance)
// équivalent à: ComboOuvre(FEN_Client.COMBO_VilleFrance)

// Modification de la couleur de fond du champ ChTotalHT
// dans l'état ETAT_Commande
ChTotalHT.CouleurFond = LightBlue
// équivalent à ETAT_Commande.ChTotalHT.CouleurFond = BleuClair

// Initialisation du champ de saisie SAI_Ville de la
// fenêtre FEN_Client depuis une autre fenêtre
FEN_Client.SAI_Ville = "Montpellier"

// Rafraîchissement de la zone répétée ZR_ZoneProduit
// à partir du début de la zone répétée
LooperDisplay(ZR_ZoneProduit, taStart)
// équivalent à: ZoneRépétéeAffiche(PAGE_PageClient.ZR_ZoneProduit, taDébut)

Special cases: Items of a data file or query

To handle an item in a data file or query through programming, simply:

use the name of the item directly. This syntax is valid only if the item is handled by a function or by a property into which the name of the data file or the name of the query to which the item belongs is specified.
use the following syntax: "<FileName/ItemName>.<ItemName>".

For example:

// Affectation dans la rubrique CP du fichier de données Client
// de la valeur saisie dans le champ SAI_CodePostal
CLIENT.CP = SAI_CodePostal

// Avance jusqu'au 2000ième enregistrement
// du fichier CLIENT selon la rubrique NOMCLI
HReadFirst(CLIENT, NOMCLI)
HForward(CLIENT, NOMCLI, 1999)

Handling a third-level element

To handle a third-level element (control within a supercontrol, toolbar, table column, etc.) in a WLanguage event or process, simply:

use the name of this third-level element directly. This syntax is valid only if the following conditions are fulfilled:
- this third-level element is handled from the second-level element to which it belongs (supercontrol, toolbar or table).
- no other third-level element uses the same name.
use the following notation if the third-level element is used from the window (or from the report) to which it belongs: "<Name2ndLevelElement>.<Name3rdLevelElement>".
use the following notation if the third-level element is handled from another window (or from another report): "<ElementName>.<Name2ndLevelElement>.<Name3rdLevelElement>".

A third-level element can be handled:

in a WLanguage function.
with a WLanguage property.
in direct assignment.

For example:

// Modification de la largeur de la colonne COL_NomClient
// Aucune autre colonne COL_NomClient n'est présente dans la fenêtre
COL_NomClient.Largeur += 10

// Modification du nombre de caractères maximum du champ SAI_Police
// appartenant au superchamp SC_SchStyle depuis la fenêtre du superchamp
SC_SchStyle.SAI_Police.Taille += 10

// Modification de la hauteur du champ SAI_Police appartenant à la
// barre d'outils BAR_Style depuis une autre fenêtre
FEN_Client.BAR_Style.SAI_Police.Hauteur += 10

Special cases: Menu options

To handle a menu option through programming, you must:

use the name of the option directly. This syntax is valid only if the menu option is handled from the menu or from the window associated with the menu.
use one of the following syntaxes: "<WindowName>.<OptionName>" or "<WindowName>.<MenuName>.<OptionName>".

For example:

// Changement de la couleur de la police de l'option OPT_FicheClient
// du menu MENU_Client depuis la fenêtre de ce menu
OPT_FicheClient.Couleur = DarkBlue

// Changement de la couleur de la police de l'option OPT_FicheClient
// du menu MENU_Client depuis une autre fenêtre
FEN_Client.MENU_Client.OPT_FicheClient.Couleur = DarkBlue
// équivalent à: FEN_Client.OPT_FicheClient.Couleur = BleuFoncé

Retrieving the name of an element in the code

Overview

To retrieve the name of an element (regardless of its level) in the code:

use the automatic completion.
The automatic completion proposes an assisted input of the WLanguage code. For more details, see Automatic completion.
perform Drag and Drop operations between the element to use and the code window.
These Drag and Drop operations can be performed:
- between the "Project explorer" pane and the code window.
- between the "Project explorer" pane and the "Context-sensitive view of code" pane.
- between the element and the code window.
- between the element and the "Context-sensitive view of code" pane.

Retrieving the name of an element by Drag and Drop

To retrieve the name of an element by Drag and Drop:

Select the element whose name must be retrieved:
- in the "Project explorer" pane.
- from an editor (window editor to retrieve the name of a control for example).
Keep the left mouse button down while moving the element:
- toward the code window.
- toward the "Context-sensitive view of code" pane.
Release the mouse button at the location where the name of the element should be used. The name of the dropped element is displayed.