Function Reference


_GUICtrlButton_GetNote

Gets the text of the note associated with the Command Link button

#include <GuiButton.au3>
_GUICtrlButton_GetNote ( $hWnd )

Parameters

$hWnd Control ID/Handle to the control

Return Value

Success: the text associated with the Command Link Button.
Failure: an empty string.

Remarks

This function works only with the $BS_COMMANDLINK and $BS_DEFCOMMANDLINK button styles.

Windows Vista or later.

Related

_GUICtrlButton_GetNoteLength, _GUICtrlButton_SetNote

See Also

Search BCM_GETNOTE in MSDN Library.

Example

#include <GuiButton.au3>
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>

Global $g_idMemo

; Note the controlID from these button(s) can NOT be read with GUICtrlRead.

Example()

Func Example()
        Local $hGUI = GUICreate("Button Get/Set Note (v" & @AutoItVersion & ")", 400, 400)
        $g_idMemo = GUICtrlCreateEdit("", 10, 75, 390, 315, $WS_VSCROLL)
        GUICtrlSetFont($g_idMemo, 9, 400, 0, "Courier New")

        Local $hButton = _GUICtrlButton_Create($hGUI, "Button1", 10, 10, 160, 60, BitOR($BS_COMMANDLINK, $BS_DEFCOMMANDLINK))
        _GUICtrlButton_SetNote($hButton, "This is a test of Vista")

        GUISetState(@SW_SHOW)

        MemoWrite("Note: " & _GUICtrlButton_GetNote($hButton))
        MemoWrite("Note Length: " & _GUICtrlButton_GetNoteLength($hButton))
        MemoWrite("Button Text: " & _GUICtrlButton_GetText($hButton))

        While 1
                Switch GUIGetMsg()
                        Case $GUI_EVENT_CLOSE
                                ExitLoop
                EndSwitch
        WEnd

        Exit
EndFunc   ;==>Example

; Write a line to the memo control.
Func MemoWrite($sMessage)
        GUICtrlSetData($g_idMemo, $sMessage & @CRLF, 1)
EndFunc   ;==>MemoWrite