CMFCRibbonComboBox クラス
CMFCRibbonComboBox クラスは、リボン バー、リボン パネル、またはリボン ポップアップ メニューに追加できるコンボ ボックス コントロールを実装します。
構文
class CMFCRibbonComboBox : public CMFCRibbonEdit
メンバー
コンストラクター
| 名前 | 説明 |
|---|---|
| CMFCRibbonComboBox::CMFCRibbonComboBox | CMFCRibbonComboBox オブジェクトを構築します。 |
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CMFCRibbonComboBox::AddItem | リスト ボックスに一意の項目を追加します。 |
| CMFCRibbonComboBox::D eleteItem | リスト ボックスから指定した項目を削除します。 |
| CMFCRibbonComboBox::EnableDropDownListResize | リスト ボックスがドロップダウン時にサイズを変更できるかどうかを指定します。 |
| CMFCRibbonComboBox::FindItem | 指定した文字列と一致するリスト ボックス内の最初の項目のインデックスを返します。 |
| CMFCRibbonComboBox::GetCount | リストボックス内の項目の数を返します |
| CMFCRibbonComboBox::GetCurSel | リスト ボックスで現在選択されている項目のインデックスを取得します。 |
| CMFCRibbonComboBox::GetDropDownHeight | リスト ボックスがドロップダウンされたときのリスト ボックスの高さを取得します。 |
| CMFCRibbonComboBox::GetIntermediateSize | 中間モードで表示されるコンボ ボックスのサイズを返します。 |
| CMFCRibbonComboBox::GetItem | リスト ボックス内の指定したインデックス位置にある項目に関連付けられた文字列を返します。 |
| CMFCRibbonComboBox::GetItemData | リスト ボックス内の指定したインデックス位置にある項目に関連付けられたデータを返します。 |
| CMFCRibbonComboBox::HasEditBox | コントロールに編集ボックスが含まれているかどうかを示します。 |
| CMFCRibbonComboBox::IsResizeDropDownList | リスト ボックスのサイズを変更できるかどうかを示します。 |
| CMFCRibbonComboBox::OnSelectItem | ユーザーがリスト ボックス内の項目を選択すると、フレームワークによって呼び出されます。 |
| CMFCRibbonComboBox::RemoveAllItems | リスト ボックスからすべてのアイテムを削除し、編集ボックスをクリアします。 |
| CMFCRibbonComboBox::SelectItem | リスト ボックス内の項目を選択します。 |
| CMFCRibbonComboBox::SetDropDownHeight | ドロップダウン時のリスト ボックスの高さを設定します。 |
解説
リボン コンボ ボックスは、ユーザーが編集できる静的ラベルまたはラベルと組み合わせたリスト ボックスで構成されます。 リボン コンボ ボックスを作成するときに、使用する種類を指定する必要があります。
例
次の例では、 CMFCRibbonComboBox クラスのオブジェクトを作成し、コンボ ボックスに項目を追加し、コンボ ボックス内の項目を選択して、コンボ ボックスをパネルに追加する方法を示します。
// Create a simple combo box with two entries:
// The first parameter is the id of the combo box.
// The third parameter is the width of the combo box in pixels.
// The fourth parameter is the display label of the combo box.
// The fifth parameter is the index of the small image of the combo box.
CMFCRibbonComboBox *pComboSimple = new CMFCRibbonComboBox(-1, FALSE, -1, 0, -1);
// Add two items to the combo box and select the first item in the list:
pComboSimple->AddItem(_T("Hi!"));
pComboSimple->AddItem(_T("Hello!"));
pComboSimple->SelectItem(0);
// Add combo button to "Favorites" panel:
// CMFCRibbonPanel* pPanelFavorites
pPanelFavorites->Add(pComboSimple);
継承階層
要件
Header: afxribboncombobox.h
CMFCRibbonComboBox::AddItem
リスト ボックスに一意の項目を追加します。
virtual INT_PTR AddItem(
LPCTSTR lpszItem,
DWORD_PTR dwData=0);
パラメーター
lpszItem
[in]追加する項目の文字列。
dwData
[in]追加する項目に関連付けられているデータ。
戻り値
追加された項目の 0 から始まるインデックス。
CMFCRibbonComboBox::CMFCRibbonComboBox
CMFCRibbonComboBox オブジェクトを構築します。
public:
CMFCRibbonComboBox(
UINT nID,
BOOL bHasEditBox=TRUE,
Int nWidth=-1,
LPCTSTR lpszLabel=NULL,
Int nImage=-1);
protected:
CMFCRibbonComboBox();
パラメーター
nID
[in]コンボ ボックスの ID。
bHasEditBox
[in]コントロール内の編集ボックスが必要な場合は TRUE。それ以外の場合は FALSE。
nWidth
[in]コンボ ボックスの幅 (ピクセル単位)。既定の幅の場合は -1 です。
lpszLabel
[in]コンボ ボックスの表示ラベル。
nImage
[in]コンボ ボックスの小さな画像インデックス。
解説
既定の幅は 108 ピクセルです。
CMFCRibbonComboBox::D eleteItem
リスト ボックスから指定した項目を削除します。
BOOL DeleteItem(int iIndex);
BOOL DeleteItem(DWORD_PTR dwData);
BOOL DeleteItem(LPCTSTR lpszText);
パラメーター
iIndex
[in]削除する項目の 0 から始まるインデックス。
dwData
[in]削除するアイテムに関連付けられているデータ。
lpszText
[in]削除するアイテムの文字列。 同じ文字列を持つ複数の項目がある場合、最初の項目は削除されます。
戻り値
指定した項目が削除された場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonComboBox::EnableDropDownListResize
リスト ボックスがドロップダウン時にサイズを変更できるかどうかを指定します。
void EnableDropDownListResize(BOOL bEnable=FALSE);
パラメーター
bEnable
[in]サイズ変更を有効にする場合は TRUE。サイズ変更を無効にする場合は FALSE。
解説
サイズ変更が有効になっている場合、リスト ボックスは表示される項目に合わせてサイズを変更します。
CMFCRibbonComboBox::FindItem
指定した文字列と一致するリスト ボックス内の最初の項目のインデックスを返します。
int FindItem(LPCTSTR lpszText) const;
パラメーター
lpszText
[in]リスト ボックス内の項目の文字列。
戻り値
項目の 0 から始まるインデックス。項目が見つからない場合は -1。
解説
CMFCRibbonComboBox::GetCount
リストボックス内の項目の数を返します
INT_PTR GetCount() const;
戻り値
リスト ボックス内の項目の数。リスト ボックスに項目が含まれている場合は 0。
解説
CMFCRibbonComboBox::GetCurSel
リスト ボックスで現在選択されている項目のインデックスを取得します。
int GetCurSel() const;
戻り値
リスト ボックスで現在選択されている項目の 0 から始まるインデックス。項目が選択されていない場合は -1。
CMFCRibbonComboBox::GetDropDownHeight
リスト ボックスがドロップダウンされたときのリスト ボックスの高さを取得します。
int GetDropDownHeight();
戻り値
リスト ボックスの高さ (ピクセル単位)。
解説
CMFCRibbonComboBox::GetIntermediateSize
中間モードで表示されるコンボ ボックスのサイズを返します。
virtual CSize GetIntermediateSize(CDC* pDC);
パラメーター
pDC
[in]コンボ ボックスのデバイス コンテキストへのポインター。
戻り値
コンボ ボックスのサイズ。
解説
返されるサイズは、小さな画像を表示するときのコンボ ボックスのサイズに基づきます。
CMFCRibbonComboBox::GetItem
リスト ボックス内の指定したインデックス位置にある項目に関連付けられた文字列を返します。
LPCTSTR GetItem(int iIndex) const;
パラメーター
iIndex
[in]リスト ボックス内の項目の 0 から始まるインデックス。
戻り値
項目に関連付けられている文字列へのポインター。それ以外の場合、インデックス パラメーターが無効な場合、またはインデックス パラメーターが -1 でコンボ ボックスで項目が選択されていない場合は NULL。
解説
CMFCRibbonComboBox::GetItemData
リスト ボックス内の指定したインデックス位置にある項目に関連付けられたデータを返します。
DWORD_PTR GetItemData(int iIndex) const;
パラメーター
iIndex
[in]リスト ボックス内の項目の 0 から始まるインデックス。
戻り値
アイテムに関連付けられているデータ。または、項目が存在しない場合、またはインデックス パラメーターが -1 で、リスト ボックスに選択された項目がない場合は 0。
CMFCRibbonComboBox::HasEditBox
コントロールに編集ボックスが含まれているかどうかを示します。
BOOL HasEditBox() const;
戻り値
コントロールに編集ボックスが含まれている場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonComboBox::IsResizeDropDownList
リスト ボックスのサイズを変更できるかどうかを示します。
BOOL IsResizeDropDownList() const;
戻り値
リスト ボックスのサイズを変更できる場合は TRUE。それ以外の場合は FALSE。 CMFCRibbonComboBox::EnableDropDownListResize
解説
リスト ボックスのサイズ変更を有効にするには、 CMFCRibbonComboBox::EnableDropDownListResize メソッドを使用します。
CMFCRibbonComboBox::OnSelectItem
ユーザーがリスト ボックス内の項目を選択すると、フレームワークによって呼び出されます。
virtual void OnSelectItem(int nItem);
パラメーター
nItem
[in]選択した項目のインデックス。
解説
ユーザー入力の選択を処理する場合は、このメソッドをオーバーライドします。
CMFCRibbonComboBox::RemoveAllItems
リスト ボックスからすべてのアイテムを削除し、編集ボックスをクリアします。
void RemoveAllItems();
解説
CMFCRibbonComboBox::SelectItem
リスト ボックス内の項目を選択します。
BOOL SelectItem(int iIndex);
BOOL SelectItem(DWORD_PTR dwData);
BOOL SelectItem(LPCTSTR lpszText);
パラメーター
iIndex
[in]リスト ボックス内の項目の 0 から始まるインデックス。
dwData
[in]リスト ボックス内のアイテムに関連付けられているデータ。
lpszText
[in]リスト ボックス内の項目の文字列。
戻り値
メソッドが成功した場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonComboBox::SetDropDownHeight
ドロップダウン時のリスト ボックスの高さを設定します。
void SetDropDownHeight(int nHeight);
パラメーター
nHeight
[in]リスト ボックスの高さ (ピクセル単位)。
解説
既定の高さは 150 ピクセルです。