CEdit::SetCueBanner
更新 : 2007 年 11 月
コントロールが空のときに、エディット コントロールにヒントとして表示されるテキストを設定します。
BOOL SetCueBanner(
LPCWSTR lpszText
);
BOOL SetCueBanner(
LPCWSTR lpszText,
BOOL fDrawWhenFocused = FALSE
);
パラメータ
[入力] lpszText
エディット コントロールに表示されるヒントを格納する文字列へのポインタ。[入力] fDrawWhenFocused
false にすると、ユーザーがエディット コントロールをクリックしてそのコントロールにフォーカスを設定しても、ヒントの見出しは描画されません。true にすると、コントロールにフォーカスがあるときにヒントの見出しが描画されます。ユーザーがコントロールで入力を開始すると、ヒントの見出しは消えます。
既定値は false です。
戻り値
このメソッドが成功した場合は true。それ以外の場合は false。
解説
このメソッドは、EM_SETCUEBANNER メッセージを送信します。このメッセージについては、Windows SDK を参照してください。詳細については、Edit_SetCueBannerTextFocused マクロを参照してください。
必要条件
ヘッダー : afxwin.h
このコントロールは Windows XP 以降でサポートされています。
このメソッドに関するその他の要件については、「Windows Vista コモン コントロールの作成要件」を参照してください。
使用例
CEdit::SetCueBanner メソッドの例を次に示します。
m_cedit.SetCueBanner(_T("First, enter text here..."), TRUE);