CListCtrl::GetGroupRect

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

更新 : 2007 年 11 月

現在のリストビューコントロール内の指定されたグループに外接する四角形を取得します。

BOOL GetGroupRect(
          int iGroupId, 
          LPRECT lpRect, 
          int iCoords = LVGGR_GROUP
) const;

パラメータ

パラメータ	説明
[入力] iGroupId	グループを指定します。
[入力、出力] lpRect	RECT 構造体へのポインタ。このメソッドが成功すると、iGroupId で指定されているグループの四角形の座標がその構造体に取り込まれます。
[入力] iCoords	取得する四角形の座標を指定します。次のいずれかの値を使用します。 LVGGR_GROUP - (既定) 展開したグループ全体の座標。 LVGGR_HEADER - ヘッダーだけ (折りたたんだグループ) の座標。 LVGGR_SUBSETLINK - サブセットリンクだけ (マークアップサブセット) の座標。

[入力] iGroupId

グループを指定します。

[入力、出力] lpRect

RECT 構造体へのポインタ。このメソッドが成功すると、iGroupId で指定されているグループの四角形の座標がその構造体に取り込まれます。

[入力] iCoords

取得する四角形の座標を指定します。次のいずれかの値を使用します。

LVGGR_GROUP - (既定) 展開したグループ全体の座標。
LVGGR_HEADER - ヘッダーだけ (折りたたんだグループ) の座標。
LVGGR_SUBSETLINK - サブセットリンクだけ (マークアップサブセット) の座標。

戻り値

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

解説

呼び出し元は、pRect パラメータで参照されている RECT 構造体を割り当てる必要があります。

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

必要条件

ヘッダー : afxcmn.h

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

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

使用例

次のコード例では、現在のリストビューコントロールにアクセスするために使用される変数 m_listCtrl を定義しています。この変数は、次の例で使用されます。

public:
    // Variable used to access the list control.
    CListCtrl m_listCtrl;

GetGroupRect メソッドのコード例を次に示します。このコード例の前半部分では、"ClientID" および "Grade" というタイトルの 2 つの列をレポートビューに表示するリストビューコントロールを作成しました。次のコード例では、インデックスが 0 のグループが存在する場合に、そのグループの周囲に 3D の四角形を描画します。

   // GetGroupRect

    // Get the graphics rectangle that surrounds group 0.
    CRect rect;
    BOOL bRet = m_listCtrl.GetGroupRect( 0, &rect, LVGGR_GROUP); 
    // Draw a blue rectangle around group 0.
    if (bRet == TRUE) {
        m_listCtrl.GetDC()->Draw3dRect( &rect, RGB(0, 0, 255), RGB(0, 0, 255));
    }
    else {
        AfxMessageBox(_T("No group information was retrieved."), MB_ICONINFORMATION);
    }