CMFCPropertyGridCtrl::HitTest
指定された位置がプロパティ グリッド コントロール項目内に存在する場合、その項目に対応するプロパティ オブジェクトへのポインターを取得します。このメソッドは、位置を含むプロパティ グリッド コントロール内の領域も示します。
CMFCPropertyGridProperty* HitTest(
CPoint pt,
CMFCPropertyGridProperty::ClickArea* pnArea=NULL,
BOOL bPropsOnly=FALSE
) const;
パラメーター
[入力] pt
クライアント座標で示された位置。[入力、出力] pnArea
ClickArea 変数へのポインター。このメソッドから制御が返されるとき、指定した位置を含むプロパティ領域がこの変数に示されます。プロパティ領域の詳細については、「解説」を参照してください。[入力] bPropsOnly
プロパティ領域のみテストする場合は TRUE。指定した位置がプロパティ領域に存在しないとき、説明領域をテストする場合は FALSE。既定値 FALSE です。説明領域の詳細については、「解説」を参照してください。
戻り値
bPropsOnly パラメーターが TRUE で、指定した位置がプロパティ領域に存在する場合、対応するプロパティ オブジェクトへのポインターが戻り値となります。また、pnArea パラメーターは、指定した位置を含む特定の領域に設定されます。それ以外の場合、戻り値は NULL で、pnArea パラメーターは変更されません。
bPropsOnly パラメーターが FALSE の場合、戻り値は常に NULL です。ただし、指定した位置が説明領域に存在する場合、pnArea パラメーターは CMFCPropertyGridProperty::ClickDescription に設定されます。
解説
プロパティ領域という用語は、プロパティ グリッド コントロール項目の名前、値、展開ボックスのいずれかの領域を指します。説明領域は、プロパティ グリッド コントロールの下部にあるゾーンのことです。プロパティ グリッド コントロール項目をクリックすると、そのプロパティの説明が説明領域に表示されます。
このメソッドは、pnArea パラメーターが指す変数の値を設定します。有効な値および対応する領域の一覧を次の表に示します。
値 |
区分 |
|---|---|
ClickArea::ClickExpandBox |
プロパティ展開ボックス コントロール。 |
ClickArea::ClickName |
プロパティ名。 |
ClickArea::ClickValue |
プロパティ値。 |
CMFCPropertyGridProperty::ClickDescription |
プロパティ グリッド コントロールの説明領域。 |
必要条件
ヘッダー : afxpropertygridctrl.h