Sets the textual cue, or tip, that is displayed by the edit control to prompt the user for information.
Syntax
To send this message, call the
SendMessage
function as follows.
lResult = SendMessage( // returns LRESULT in lResult
hWndControl, // (HWND) handle to destination control
EM_SETCUEBANNER, // (UINT) message ID
wParam, // = (WPARAM)(BOOL) wParam;
lParam // = (LPARAM)(LPCWSTR) lParam;
);
Parameters
- wParam
-
[in] TRUE if the cue banner should show even when the edit control has focus; otherwise, FALSE. FALSE is the default behavior—the cue banner disappears when the user clicks in the control.
- lParam
-
[in] A pointer to a Unicode string that contains the text to display as the textual cue.
Return Value
If the message succeeds, it returns TRUE. Otherwise it returns FALSE.
Remarks
An edit control that is used to begin a search may display "Enter search here" in gray text as a textual cue. When the user clicks the text, the text goes away and the user can type.
You cannot set a cue banner on a multiline edit control or on a rich edit control.
Note To use this API, you must provide a manifest specifying Comclt32.dll version 6.0. For more information on manifests, see
Enabling Visual Styles.
Message Information
| Header | Declared in Commctrl.h |
|---|
| Minimum operating systems |
Windows XP |
|---|
See Also
Edit_SetCueBannerText