Functions > GUI >

GUICtrlRead

Lit l'�tat ou les donn�es d'un contr�le.

GUICtrlRead ( controlID [, advanced = 0] )

Param�tres

controlID L'identifiant du contr�le (controlID) tel que retourn� par une fonction GUICtrlCreate...(), ou -1 pour d�signer le dernier contr�le cr��.
advanced [optionnel] Retourne des informations compl�mentaires sur un contr�le.
    $GUI_READ_DEFAULT (0) = (par d�faut) Renvoie une valeur de l'�tat ou des donn�es du contr�le.
    $GUI_READ_EXTENDED (1) = Retourne des informations compl�mentaires sur le contr�le (Voir Remarques).

Les constantes sont d�finies dans GUIConstantsEx.au3.

Valeur de retour

Succ�s: Retourne une valeur qui d�pend du contr�le (voir ci-dessous).
�chec: Retourne 0.

Type Valeur
Checkbox, Radio L'�tat coch�/d�coch� ($GUI_CHECKED ou $GUI_UNCHECKED)
Combo, List La valeur s�lectionn�e
Input, Edit Le texte entr�
Button Le texte affich�
Date La date s�lectionn�e dans le format d�fini par les param�tres r�gionaux
Progress Pourcentage en cours
Slider Valeur en cours
Tab L'index, de base 0, du TabItem s�lectionn�
Menu, MenuItem �tat du menu/item. Consultez Tableau des �tats
TreeView Identifiant du contr�le (controlID) du TreeViewItem s�lectionn�
TreeViewItem �tat du TreeViewItem
ListView Identifiant du contr�le (controlID) du ListViewItem s�lectionn�. 0 signifie aucun item s�lectionn�
ListViewItem Le texte de l'item/ligne s�lectionn� dans le ListView
Dummy La valeur d�finie par GUICtrlSendToDummy ou GUICtrlSetData

Remarques

En mode 'avanc�' la valeur de retour contient des donn�es suppl�mentaires sur le contr�le (Voir ci-dessous).
Note: pas tous les contr�les retournent des donn�es suppl�mentaires!

Type Valeurs suppl�mentaires
Checkbox, Radio Le texte du contr�le.
Menu, MenuItem Le texte du contr�le.
TreeView Le texte du TreeViewItem actuellement s�lectionn�.
TreeViewItem Le texte du TreeViewItem.
ListViewItem L'�tat du ListViewItem si le style �tendu $LVS_EX_CHECKBOXES est utilis� en mode avanc�. Voir Tableau des �tats
Tab Le controlID du TabItem s�lectionn�

Pour les contr�les Checkbox et Radio seuls les �tats $GUI_CHECKED (1), $GUI_UNCHECKED (4) ou $GUI_INDETERMINATE (2) sont retourn�s, aussi la valeur peut �tre utilis�e directement.

Pour les items Listview plusieurs �tats peuvent �tre retourn�s comme $GUI_CHECKED et $GUI_UNCHECKED (uniquement pour les contr�les Listview avec LVS_EX_CHECKBOXES-exstyle et avec retour 'avanc�'). Donc, utilisez BitAND(GUICtrlRead($item), $GUI_CHECKED) pour tester si l'item est coch�.

Pour les items de Treeview plusieurs �tats peuvent �tre retourn�s comme $GUI_FOCUS, $GUI_EXPAND et $GUI_CHECKED, $GUI_UNCHECKED (uniquement pour les contr�les Treeview avec le style TVS_CHECKBOXES. Donc utilisez BitAND(GUICtrlRead($item), $GUI_CHECKED) pour tester si l'item est coch�.

En relation

GUICtrlCreate..., GUICtrlGetState, GUICtrlSendMsg, GUICtrlSendToDummy, GUICtrlSetData, GUICtrlUpdate..., GUIEventOptions (Option), GUIGetMsg

Exemple

#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>

Example()

Func Example()
    GUICreate("My GUICtrlRead") ; Cr�e une GUI centr�e

    Local $idMenu1 = GUICtrlCreateMenu("File")

    Local $idList = GUICtrlCreateList("", 10, 10, -1, 100)
    GUICtrlSetData(-1, "item1|item2|item3", "item2")

    Local $idButton = GUICtrlCreateButton("Read", 10, 110, 50)
    GUICtrlSetState(-1, $GUI_FOCUS) ; le focus est mis sur ce bouton

    GUISetState(@SW_SHOW) ; Affiche la GUI

    Local $idMsg, $iMenustate, $sMenutext
    ; Boucle jusqu'� ce que l'utilisateur quitte.
    Do
        $idMsg = GUIGetMsg()
        If $idMsg = $idButton Then
            MsgBox($MB_SYSTEMMODAL, "Selected listbox entry", GUICtrlRead($idList)) ; Affiche l'entr�e de zone de liste s�lectionn�e
            $iMenustate = GUICtrlRead($idMenu1) ; renvoie l'�tat de l'item du menu
            $sMenutext = GUICtrlRead($idMenu1, 1) ; renvoie le texte de l'item du menu
            MsgBox($MB_SYSTEMMODAL, "State and text of the menuitem", "state:" & $iMenustate & @CRLF & "text:" & $sMenutext)
        EndIf
    Until $idMsg = $GUI_EVENT_CLOSE
EndFunc   ;==>Example