Help Center
/
Help Center›AfxNova›CEdit Class

CEdit.SetCueBannerTextmethod

Sets the textual cue, or tip, that is displayed by the edit control to prompt the user for information.

WindowsmethodCEdit.incdocumented

Syntax

SUB SetCueBannerText (BYVAL hEdit AS HWND, BYVAL pwszText AS WSTRING PTR, BYVAL fDrawFocused AS BOOLEAN = FALSE) AS LONG

Parameters

NameDescription
hEditThe handle of the edit control.
pwszTextA pointer to a Unicode string that contains the text to display as the textual cue.
bDrawFocusedTRUE 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.

Return value

If the message succeeds, it returns TRUE. Otherwise it returns FALSE.

Description

Sets the text that is displayed as the textual cue, or tip, for an edit control.

Example

CEdit.SetCueBanneText(hEdit, "Cue text)

Reference

  • Include file CEdit.inc
  • Defined in AfxNova/CEdit.inc:555
  • Documented in Windows/WIndows Controls/CEdit Class.md
  • Topic: CEdit Class