Edit_SetCueBannerTextFocused macro (commctrl.h)
Sets the text that is displayed as the textual cue, or tip, for an edit control. You can use this macro or send the EM_SETCUEBANNER message explicitly.
Syntax
BOOL Edit_SetCueBannerTextFocused(
HWND hwnd,
LPCWSTR lpcwText,
BOOL fDrawFocused
);
Parameters
hwnd
Type: HWND
A handle to the edit control.
lpcwText
Type: LPCWSTR
A pointer to a Unicode string that contains the text to set as the textual cue.
fDrawFocused
Type: BOOL
Sets whether the cue text is drawn when the control has keyboard focus.
Return value
Type: BOOL
If the macro 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. fDrawFocused controls when the cue text disappears. If fDrawFocused is FALSE, then the cue text disappears when the edit control receives focus. If fDrawFocused is TRUE, then the cue text disappears when the user enters text into the edit control.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | commctrl.h |
See also
Conceptual
Reference