CComboBox::SetCueBanner

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

コンボボックスコントロールで表示するヒントのテキストを設定します。

BOOL SetCueBanner(
          LPCTSTR lpszText
);

パラメータ

パラメータ	説明
[入力] lpszText	ヒントのテキストが含まれている、null で終わるバッファへのポインタ。

戻り値

このメソッドが成功した場合は true。それ以外の場合は false。

解説

ヒントのテキストとは、コンボボックスコントロールの入力領域に表示されるプロンプトです。ユーザーが入力するまで、ヒントのテキストが表示されます。

このメソッドは、CB_SETCUEBANNER メッセージを送信します。このメッセージについては、Windows SDK を参照してください。

必要条件

ヘッダー : afxwin.h

このメソッドは、Windows Vista およびそれ以降のバージョンでサポートされています。

このメソッドに関するその他の要件については、「Windows Vista コモンコントロールの作成要件」を参照してください。

使用例

次のコード例では、コンボボックスコントロールにプログラムによってアクセスするために使用される m_combobox 変数を定義しています。この変数は、次の例で使用されます。

 // Variable to access the combo box control
    CComboBox m_combobox;

次のコード例では、コンボボックスコントロールのヒントの見出しを設定しています。

  // Add extra initialization here.

    // Add 20 items to the combo box. The Resource Editor
    // has already been used to set the style of the combo
    // box to CBS_SORT.
    CString str;
    for (int i = 1; i <= 20; i++)
    {
        str.Format(_T("Item %2d"), i); 
        m_combobox.AddString(str);
    }
    // Set the minimum visible item
    m_combobox.SetMinVisibleItems( 10 );
    // Set the cue banner
    m_combobox.SetCueBanner(_T("Select an item..."));

    // End of extra initialization.