CMFCPropertyGridProperty クラス
CMFCPropertyGridProperty オブジェクトは、プロパティ リスト コントロール内のリスト アイテムを表します。
詳細については、Visual Studio インストール先の mfc フォルダーにあるソース コードを参照してください。 たとえば、%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc のようにします。
構文
class CMFCPropertyGridProperty : public CObject
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
CMFCPropertyGridProperty::CMFCPropertyGridProperty |
CMFCPropertyGridProperty オブジェクトを構築します。 |
CMFCPropertyGridProperty::~CMFCPropertyGridProperty |
デストラクターです。 |
パブリック メソッド
保護メソッド
| 名前 | 説明 |
|---|---|
CMFCPropertyGridProperty::CreateCombo |
コンボ ボックスをプロパティに追加するためにフレームワークによって呼び出されます。 |
CMFCPropertyGridProperty::HasButton |
プロパティにボタンが含まれているかどうかを示します。 |
CMFCPropertyGridProperty::Init |
プロパティ オブジェクトを初期化するためにフレームワークによって呼び出されます。 |
CMFCPropertyGridProperty::IsSubItem |
指定したプロパティが現在のプロパティのサブ項目であるかどうかを示します。 |
CMFCPropertyGridProperty::IsValueChanged |
現在のプロパティの値が変更されたかどうかを示します。 |
CMFCPropertyGridProperty::OnCtlColor |
プロパティの背景色を塗りつぶすためにブラシを取得する必要がある場合に、フレームワークによって呼び出されます。 |
CMFCPropertyGridProperty::OnDestroyWindow |
プロパティが破棄されたとき、または編集が完了したときに、フレームワークによって呼び出されます。 |
CMFCPropertyGridProperty::OnKillFocus |
プロパティが入力フォーカスを失ったときにフレームワークによって呼び出されます。 |
データ メンバー
| 名前 | 説明 |
|---|---|
CMFCPropertyGridProperty::m_strFormatDouble |
double 型の値の書式指定文字列。 |
CMFCPropertyGridProperty::m_strFormatFloat |
float 型の値の書式指定文字列。 |
CMFCPropertyGridProperty::m_strFormatLong |
long 型の値の書式指定文字列。 |
CMFCPropertyGridProperty::m_strFormatShort |
short 型の値の書式指定文字列。 |
解説
CMFCPropertyGridProperty オブジェクトを使用してプロパティを表し、プロパティ リスト コントロールに追加します。 詳細については、「CMFCPropertyGridCtrl クラス」を参照してください。
プロパティ オブジェクトは、文字列、日付、ブール値、整数値などのデータ型を表すことができます。 子プロパティを含めたり、コンボ ボックスやボタン コントロールなどのコントロールを含めたりすることもできます。
例
次の例では、 CMFCPropertyGridProperty オブジェクトを構築する方法を示します。 この例では、 CMFCPropertyGridProperty クラスのさまざまなメソッドを使用して、オプションの追加、サブ項目の追加、プロパティの有効化、およびプロパティの表示を行う方法も示します。 この例は、 New Controls サンプルの一部です。
CMFCPropertyGridProperty *pGroup1 = new CMFCPropertyGridProperty(_T("Appearance"));
// construct a COleVariant object.
COleVariant var3DLook((short)VARIANT_FALSE, VT_BOOL);
pGroup1->AddSubItem(new CMFCPropertyGridProperty(_T("3D Look"), var3DLook,
_T("Specifies the dialog's font will be nonbold and controls will have a 3D border")));
CMFCPropertyGridProperty *pProp = new CMFCPropertyGridProperty(_T("Border"),
_T("Dialog Frame"), _T("One of: None, Thin, Resizable, or Dialog Frame"));
pProp->AddOption(_T("None"));
pProp->AddOption(_T("Thin"));
pProp->AddOption(_T("Resizable"));
pProp->AddOption(_T("Dialog Frame"));
pProp->AllowEdit(FALSE);
pGroup1->AddSubItem(pProp);
pGroup1->AddSubItem(new CMFCPropertyGridProperty(_T("Caption"), (COleVariant) _T("About NewControlsDemo"), _T("Specifies the text that will be displayed in the dialog's title bar")));
pGroup1->AdjustButtonRect();
pGroup1->AllowEdit();
pGroup1->Enable();
pGroup1->Show();
pGroup1->Redraw();
継承階層
要件
ヘッダー: afxpropertygridctrl.h
CMFCPropertyGridProperty::AddOption
プロパティ リスト コントロールに新しいリスト 項目を追加します。
BOOL AddOption(
LPCTSTR lpszOption,
BOOL bInsertUnique=TRUE);
パラメーター
lpszOption
[in]追加するリスト アイテム (オプション)。
bInsertUnique
[入力] TRUE リスト アイテムがまだ存在しない場合にのみリスト アイテムを追加する場合。それ以外の場合は FALSE。 既定値は TRUE です。
戻り値
TRUEは、リスト アイテムが追加されることを意味します。 それ以外の場合は、 FALSE、 bInsertUnique パラメーターが TRUE され、 lpszOption パラメーターで指定されたリスト アイテムが既に存在するため、リスト アイテムが追加されていないことを意味します。
CMFCPropertyGridProperty::AddSubItem
子項目をプロパティに追加します。
BOOL AddSubItem(CMFCPropertyGridProperty* pProp);
パラメーター
pProp
[in]追加するプロパティへのポインター。
戻り値
TRUE 指定したプロパティが子プロパティとして正常に追加された場合は 。 FALSE プロパティが親プロパティに既に存在するため、プロパティが追加されていない場合は 。
解説
親プロパティと子プロパティの階層リストを作成するには、このメソッドを使用します。 子プロパティを追加すると、親プロパティには、プラス記号 (+) で指定された展開ボックス コントロールが自動的に表示されます。 ユーザーがプラス記号を選択すると、親プロパティが展開され、子プロパティ項目が表示されます。
CMFCPropertyGridProperty::AdjustButtonRect
埋め込みボタンの外接する四角形のサイズを変更するようにプロパティに指示するために、親プロパティ リスト コントロールによって呼び出されます。
virtual void AdjustButtonRect();
解説
既定では、このメソッドは次のとおりです。
- ボタンの幅を、ボタンの高さと 3 ピクセルを合わせて調整します。
- ボタンの外接する四角形をプロパティの右端に移動します。
- ボタン 1 ピクセルをプロパティの上端の下にシフトします。
CMFCPropertyGridProperty::AdjustInPlaceEditRect
プロパティ値の設定に使用されるテキスト ボックスとオプションのスピン ボタン コントロールの境界を取得します。
virtual void AdjustInPlaceEditRect(
CRect& rectEdit,
CRect& rectSpin);
パラメーター
rectEdit
[out]このメソッドが返されるときに、プロパティ値のテキスト ボックスの境界を指定する四角形。
rectSpin
[out]このメソッドから制御が戻るときに、プロパティ値のスピン ボタン コントロールの境界を指定する四角形。 または、プロパティがスピン ボタンをサポートしていない場合は、空の四角形。
解説
プロパティの値領域は、テキスト ボックスと、場合によってはスピン ボタン コントロールなどの オプション ボタンで構成されます。 このメソッドは、テキスト ボックスとオプション ボタンの寸法を計算し、指定されたパラメーターでこれらの値を返します。
CMFCPropertyGridProperty::AllowEdit
プロパティを編集可能または読み取り専用にします。
void AllowEdit(BOOL bAllow=TRUE);
パラメーター
bAllow
[入力] TRUE プロパティを編集可能にする。プロパティを読み取り専用にする FALSE 。 既定値は TRUE です。
CMFCPropertyGridProperty::CMFCPropertyGridProperty
CMFCPropertyGridProperty オブジェクトを構築します。
CMFCPropertyGridProperty(
const CString& strGroupName,
DWORD_PTR dwData=0,
BOOL bIsValueList=FALSE);
CMFCPropertyGridProperty(
const CString& strName,
const _variant_t& varValue,
LPCTSTR lpszDescr=NULL,
DWORD_PTR dwData=0,
LPCTSTR lpszEditMask=NULL,
LPCTSTR lpszEditTemplate=NULL,
LPCTSTR lpszValidChars=NULL);
パラメーター
strGroupName
[in]グループ名。 グループは、プロパティ グリッド コントロールの関連プロパティのコレクションです。 コントロールが階層的に表示されている場合、 グループ名 はグループの上の行にカテゴリ タイトルとして表示されます。
dwData
[in]整数やプロパティに関連付けられている他のデータへのポインターなど、アプリケーション固有のデータ。 既定値は0です。
strName
[in] プロパティの名前。
varValue
[in]プロパティ値。
lpszDescr
[in] プロパティの説明。 既定値は NULL です。
lpszEditMask
[in]プロパティがマスクされた編集コントロールの場合は、編集マスク。 既定値は NULL です。
lpszEditTemplate
[in]プロパティがマスクされた編集コントロールの場合は、編集テンプレート。 既定値は NULL です。
lpszValidChars
[in]プロパティがマスクされた編集コントロールの場合、有効な文字の一覧。 既定値は NULL です。
bIsValueList
[入力] TRUE プロパティが値のリストを表す場合。プロパティが 1 つの値を表す場合に FALSE します。 既定値は FALSE です。
CMFCPropertyGridProperty::CreateCombo
コンボ ボックスをプロパティに追加するためにフレームワークによって呼び出されます。
virtual CComboBox* CreateCombo(
CWnd* pWndParent,
CRect rect);
パラメーター
pWndParent
[in]コンボ ボックスの親ウィンドウへのポインター。
rect
[in]コンボ ボックスの外接する四角形。
戻り値
新しい CComboBox オブジェクトへのポインター。
CMFCPropertyGridProperty::CreateInPlaceEdit
プロパティの編集可能なコントロールを作成するためにフレームワークによって呼び出されます。
virtual CWnd* CreateInPlaceEdit(
CRect rectEdit,
BOOL& bDefaultFormat);
パラメーター
rectEdit
[in]編集可能なコントロールの外接する四角形。
bDefaultFormat
[入力] TRUE 既定のプロパティ形式を使用して編集可能なコントロールのテキストを設定する場合。それ以外の場合は FALSE。
戻り値
このメソッドが成功した場合の編集可能なコントロールへのポインター。それ以外の場合は NULL。
解説
このメソッドは、CMFCPropertyGridProperty クラス コンストラクターで指定されているvarValue、lpszEditMask、lpszEditTemplate、およびlpszValidCharsパラメーターの値を使用します。 既定では、このメソッドは varValue バリアント型をサポートしています。 これには、 VT_BSTR、 VT_R4、 VT_R8、 VT_UI1、 VT_I2、 VT_INT、 VT_UINT、 VT_I4、 VT_UI2、 VT_UI4、および VT_BOOLが含まれます。
このメソッドは、1 つ以上のlpszEditMask、lpszEditTemplate、またはlpszValidCharsパラメーターが指定されている場合はCMFCMaskedEdit コントロールを作成します。それ以外の場合は、CEdit コントロールを作成します。
CMFCPropertyGridProperty::CreateSpinControl
編集可能なスピン ボタン コントロールを作成するためにフレームワークによって呼び出されます。
virtual CSpinButtonCtrl* CreateSpinControl(CRect rectSpin);
パラメーター
rectSpin
[in]編集可能なスピン ボタン コントロールを作成する場所を定義する四角形。
戻り値
CSpinButtonCtrl オブジェクトへのポインターとしてキャストされる新しいCMFCSpinButtonCtrl オブジェクトへのポインター。
解説
CMFCPropertyGridProperty::EnableSpinControl メソッドを呼び出して、プロパティの右端に編集可能なスピン ボタン コントロールを表示します。
CMFCPropertyGridProperty::Enable
プロパティを有効または無効にします。
void Enable(BOOL bEnable=TRUE);
パラメーター
bEnable
[入力] TRUE プロパティを有効にするには、プロパティを無効にする FALSE 。 無効なプロパティは、マウスまたはキーボード入力に応答しません。 既定値は TRUE です。
CMFCPropertyGridProperty::EnableSpinControl
プロパティ値の変更に使用するスピン ボタン コントロールを有効または無効にします。
void EnableSpinControl(
BOOL bEnable=TRUE,
int nMin=0,
int nMax=0);
パラメーター
bEnable
[入力] TRUE スピンボタンコントロールを有効にするには、スピン ボタン コントロールを無効にする FALSE 。 既定値は TRUE です。
nMin
[in]スピン ボタン コントロールの最小値。 既定値は0です。
nMax
[in]スピン ボタン コントロールの最大値。 既定値は0です。
解説
プロパティが編集されようとしているときに、フレームワークによってスピン ボタン コントロールが自動的に作成されます。
CMFCPropertyGridProperty::CMFCPropertyGridProperty コンストラクターのvarValue パラメーターで指定されるプロパティ型は、サポートされているバリアント型である必要があります。 それ以外の場合、このメソッドはデバッグ モードでアサートします。 サポートされている種類には、 VT_INT、 VT_UINT、 VT_I2、 VT_I4、 VT_UI2、および VT_UI4があります。
CMFCPropertyGridProperty::Expand
サブプロパティを含むプロパティを展開または折りたたみします。
void Expand(BOOL bExpand=TRUE);
パラメーター
bExpand
[入力] TRUE プロパティを展開するには、プロパティを折りたたむ FALSE します。 既定値は TRUE です。
CMFCPropertyGridProperty::FormatProperty
プロパティ値のテキスト表現の書式を設定します
virtual CString FormatProperty();
戻り値
プロパティ値のテキスト表現。
解説
このメソッドは、プロパティ値が表示される前にフレームワークによって呼び出されます。
CMFCPropertyGridProperty::GetData
プロパティに関連付けられている DWORD 値を取得します。
DWORD_PTR GetData() const;
戻り値
DWORD 値。
解説
返されるデータは、数値や他のデータへのポインターなど、アプリケーション固有の値です。 プロパティを構築するとき、または CMFCPropertyGridProperty::SetData メソッドを呼び出すときに、データ値を指定します。
CMFCPropertyGridProperty::GetDescription
プロパティの説明を取得します。
const CString& GetDescription() const;
戻り値
プロパティの説明を含むテキスト文字列。
解説
また、プロパティ リスト コントロールでは、このメソッドを使用してプロパティの説明を表示します。
CMFCPropertyGridProperty::GetExpandedSubItems
展開されたサブ項目の数を取得します。
int GetExpandedSubItems(BOOL bIncludeHidden=TRUE) const;
パラメーター
bIncludeHidden
[入力] TRUE 非表示のサブ項目をカウントに含める場合。それ以外の場合は FALSE。 既定値は TRUE です。
戻り値
展開されたサブ項目の数。
CMFCPropertyGridProperty::GetHierarchyLevel
プロパティの階層レベルの 0 から始まるインデックスを取得します。
int GetHierarchyLevel() const;
戻り値
プロパティの階層レベル。
CMFCPropertyGridProperty::GetName
プロパティの名前を取得します。
LPCTSTR GetName() const;
戻り値
プロパティの名前を含む文字列へのポインター。
CMFCPropertyGridProperty::GetNameTooltip
ツールヒントにプロパティの名前を表示するためにフレームワークによって呼び出されます。
virtual CString GetNameTooltip();
戻り値
プロパティ名を含む文字列。 既定では、戻り値は空の文字列です。
CMFCPropertyGridProperty::GetOption
インデックスで指定されたオプションのテキストを取得します。
LPCTSTR GetOption(int nIndex) const;
パラメーター
nIndex
取得するプロパティ リスト アイテム (オプション) の 0 から始まるインデックス。
戻り値
オプション テキストを含む文字列へのポインター。
CMFCPropertyGridProperty::GetOptionCount
プロパティに属するオプションの数を取得します。
int GetOptionCount() const;
戻り値
プロパティ コントロールに含まれるプロパティ リスト 項目 (オプション) の数。
解説
CMFCPropertyGridProperty::AddOption メソッドを呼び出して、プロパティ リストに項目を追加します。 CMFCPropertyGridProperty::RemoveAllOptions メソッドを呼び出して、すべての項目を削除します。
CMFCPropertyGridProperty::GetOriginalValue
現在のプロパティの初期値を取得します。
const COleVariant& GetOriginalValue() const;
戻り値
現在のプロパティの元の値。
解説
現在のプロパティの値を変更する編集操作の効果を元に戻すには、このメソッドを使用します。
現在のプロパティの元の値は、 CMFCPropertyGridProperty::CMFCPropertyGridProperty コンストラクターによって設定され、 CMFCPropertyGridProperty::SetOriginalValue メソッドによって変更され、 CMFCPropertyGridProperty::ResetOriginalValue メソッドによってリセットされます。
CMFCPropertyGridProperty::GetParent
親プロパティへのポインターを取得します。
CMFCPropertyGridProperty* GetParent() const;
戻り値
親プロパティ オブジェクトへのポインター、または最上位のプロパティの NULL 。
CMFCPropertyGridProperty::GetRect
プロパティの外接する四角形を取得します。
CRect GetRect() const;
戻り値
外接する四角形を記述する CRect オブジェクト。
CMFCPropertyGridProperty::GetSubItem
0 から始まるインデックスによって識別されるサブプロパティを取得します。
CMFCPropertyGridProperty* GetSubItem(int nIndex) const;
パラメーター
nIndex
[in]取得するプロパティの 0 から始まるインデックス。 このパラメーターは、0 より小さいか、サブプロパティの数以上の場合は無効です。
戻り値
このプロパティの子項目であるプロパティ オブジェクトへのポインター。
または
リテール モードでは、nIndex パラメーターが無効かどうかをNULLします。 デバッグ モードでは、このメソッドはアサートします。
CMFCPropertyGridProperty::GetSubItemsCount
サブ項目の数を取得します。
int GetSubItemsCount() const;
戻り値
子項目の数。
CMFCPropertyGridProperty::GetValue
プロパティ値を取得します。
virtual const _variant_t& GetValue() const;
戻り値
プロパティ値を含むバリアント。
CMFCPropertyGridProperty::GetValueTooltip
ツールヒントに表示されるプロパティ値のテキスト表現を取得するためにフレームワークによって呼び出されます。
virtual CString GetValueTooltip();
戻り値
プロパティ値のテキスト表現を含む CString オブジェクト。 既定では、この値は空の文字列です。
CMFCPropertyGridProperty::HasButton
プロパティにボタンが含まれているかどうかを示します。
virtual BOOL HasButton() const;
戻り値
TRUE プロパティにボタン (またはプロパティ リスト) が含まれている場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::HitTest
ポイントに対応するプロパティ リスト アイテムに対応するプロパティ オブジェクトをポイントします。
CMFCPropertyGridProperty* HitTest(
CPoint point,
CMFCPropertyGridProperty::ClickArea* pnArea=NULL);
CMFCPropertyGridProperty* HitTest(
CPoint pt,
CMFCPropertyGridProperty::ClickArea* pnArea=NULL,
BOOL bPropsOnly=FALSE) const;
パラメーター
point
[in]テストするポイント (クライアント座標)。 通常、このパラメーターは現在のマウス ポインターの位置です。
pt
[in]テストするポイント (クライアント座標)。
pnArea
[out]このメソッドが戻るときに、指定したポイントを含む領域を示します。 詳細については、「解説」を参照してください。 既定値は NULL です。
bPropsOnly
[入力] TRUE プロパティ コントロール内の任意の領域をテストする場合。説明領域のみをテスト FALSE 。 既定値は FALSE です。
戻り値
プロパティ オブジェクトまたは NULLへのポインター。
解説
既定では、このメソッドは、指定したポイントがプロパティ項目内に見つからない場合に、プロパティ サブ項目をテストします。
次の表に、 pnArea パラメーターに返すことができる値を示します。
| 領域 | 説明 |
|---|---|
ClickArea::ClickExpandBox |
プラス記号 (+) で指定される展開ボックス コントロール。 |
ClickArea::ClickName |
プロパティ名。 |
ClickArea::ClickValue |
プロパティ値。 |
CMFCPropertyGridProperty::Init
プロパティ オブジェクトを初期化するためにフレームワークによって呼び出されます。
void Init();
CMFCPropertyGridProperty::IsAllowEdit
プロパティが編集可能かどうかを示します。
BOOL IsAllowEdit() const;
戻り値
TRUE プロパティが編集可能な場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::IsEnabled
プロパティが有効か無効かを示します。
BOOL IsEnabled() const;
戻り値
TRUE プロパティが有効な場合は〘。プロパティが無効になっている場合に FALSE します。
解説
プロパティが有効か無効かを示します。
CMFCPropertyGridProperty::IsExpanded
プロパティを展開するか折りたたむかを示します。
BOOL IsExpanded() const;
戻り値
TRUE プロパティが展開されている場合。プロパティが折りたたまれている場合に FALSE します。
CMFCPropertyGridProperty::IsGroup
現在のプロパティがグループを表すかどうかを示します。
BOOL IsGroup() const;
戻り値
TRUE 現在のプロパティ オブジェクトがグループを表す場合。プロパティが値を表す場合に FALSE します。
解説
グループは、プロパティ グリッド コントロールの関連プロパティのコレクションです。 コントロールが階層的に表示されている場合、 グループ名 はグループの上の行にカテゴリ タイトルとして表示されます。
CMFCPropertyGridProperty::IsInPlaceEditing
現在のプロパティが編集可能かどうかを示します。
BOOL IsInPlaceEditing() const;
戻り値
TRUE 現在のプロパティが編集可能な場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::IsModified
現在のプロパティが変更されているかどうかを示します。
BOOL IsModified() const;
戻り値
TRUE プロパティが変更された場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::IsParentExpanded
現在のプロパティの親が展開されているかどうかを示します。
BOOL IsParentExpanded() const;
戻り値
TRUE 現在のプロパティのすべての親が展開されている場合。親プロパティが折りたたまれている場合に FALSE します。
CMFCPropertyGridProperty::IsSelected
現在のプロパティが選択されているかどうかを示します。
virtual BOOL IsSelected() const;
戻り値
TRUE 現在のプロパティが選択されている場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::IsSubItem
指定したプロパティが現在のプロパティのサブ項目であるかどうかを示します。
BOOL IsSubItem(CMFCPropertyGridProperty* pProp) const;
パラメーター
pProp
[in]プロパティへのポインター。
戻り値
TRUE 指定したプロパティが現在のプロパティのサブ項目である場合は。それ以外の場合は FALSE。
CMFCPropertyGridProperty::IsValueChanged
現在のプロパティの値が変更されたかどうかを示します。
virtual BOOL IsValueChanged() const;
戻り値
TRUE 現在のプロパティの値が変更された場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::IsVisible
現在のプロパティが表示されるかどうかを示します。
BOOL IsVisible() const;
戻り値
TRUE 現在のプロパティが表示されている場合。然も無くば; FALSE。
CMFCPropertyGridProperty::m_strFormatDouble
double 型の値の書式指定文字列を保持します。
static CString m_strFormatDouble;
CMFCPropertyGridProperty::m_strFormatFloat
float 型の値の書式指定文字列を保持します。
static CString m_strFormatFloat;
CMFCPropertyGridProperty::m_strFormatLong
long 型の値の書式指定文字列を保持します。
static CString m_strFormatLong;
CMFCPropertyGridProperty::m_strFormatShort
short 型の値の書式指定文字列を保持します。
static CString m_strFormatShort;
CMFCPropertyGridProperty::OnClickButton
ユーザーがプロパティに含まれるボタンを選択すると、フレームワークによって呼び出されます。
virtual void OnClickButton(CPoint point);
パラメーター
point
[in]ポイント (クライアント座標)。
解説
既定では、このメソッドは何も実行しません。
CMFCPropertyGridProperty::OnClickName
ユーザーがプロパティの名前フィールドを選択すると、親プロパティ リスト コントロールによって呼び出されます。
virtual void OnClickName(CPoint C);
パラメーター
C
[in]ポイント (クライアント座標)。
解説
既定では、このメソッドは何も実行しません。
CMFCPropertyGridProperty::OnClickValue
ユーザーがプロパティの値フィールドを選択すると、親プロパティ リスト コントロールによって呼び出されます。
virtual BOOL OnClickValue(
UINT uiMsg,
CPoint point);
パラメーター
uiMsg
[in]マウス メッセージ。
point
[in]ポイント (クライアント座標)。
戻り値
TRUE 指定されたマウス メッセージがこのメソッドによって処理される場合。それ以外の場合は FALSE。
解説
既定では、現在のプロパティが編集できない場合、このメソッドは FALSE を返します。 それ以外の場合、このプロパティに関連付けられている編集コントロールまたはスピン コントロールは、指定したマウス メッセージを処理し、このメソッドは TRUEを返します。
CMFCPropertyGridProperty::OnCloseCombo
プロパティに含まれるコンボ ボックスが閉じられたときにフレームワークによって呼び出されます。
virtual void OnCloseCombo();
CMFCPropertyGridProperty::OnCtlColor
プロパティの背景色を塗りつぶすためにブラシを取得する必要がある場合に、フレームワークによって呼び出されます。
virtual HBRUSH OnCtlColor(
CDC* pDC,
UINT nCtlColor);
パラメーター
pDC
[in]デバイス コンテキストへのポインター。
nCtlColor
[in](このパラメーターは使用されません)。
戻り値
このメソッドが成功した場合のブラシへのハンドル。それ以外の場合は NULL。
CMFCPropertyGridProperty::OnDblClk
ユーザーがプロパティをダブルクリックすると、フレームワークによって呼び出されます。
virtual BOOL OnDblClk(CPoint point);
パラメーター
point
[in]ポイント (クライアント座標)。
戻り値
TRUE このメソッドが成功した場合。それ以外の場合は FALSE。
解説
既定では、このメソッドはプロパティ リスト コントロール内の次のプロパティ項目を選択します。
CMFCPropertyGridProperty::OnDestroyWindow
プロパティが破棄されたとき、または編集が完了したときに、フレームワークによって呼び出されます。
virtual void OnDestroyWindow();
CMFCPropertyGridProperty::OnDrawButton
プロパティに含まれるボタンを描画するためにフレームワークによって呼び出されます。
virtual void OnDrawButton(
CDC* pDC,
CRect rectButton);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
rectButton
[in]ボタンを描画する場所を指定する外接する四角形。
CMFCPropertyGridProperty::OnDrawDescription
プロパティの説明を描画するためにフレームワークによって呼び出されます。
virtual void OnDrawDescription(
CDC* pDC,
CRect rect);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
rect
[in]プロパティの説明を描画する場所を指定する外接する四角形。
解説
既定では、このメソッドは、親プロパティ リスト コントロールで使用されるフォントにプロパティ名と説明を描画します。 プロパティの説明は通常のスタイルで描画され、プロパティ名は太字で描画されます。
CMFCPropertyGridProperty::OnDrawExpandBox
サブプロパティを含むプロパティの近くに展開ボックス コントロールを描画するために、フレームワークによって呼び出されます。
virtual void OnDrawExpandBox(
CDC* pDC,
CRect rectExpand);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
rectExpand
[in]展開ボックス コントロールを描画する場所を指定する外接する四角形。
解説
展開ボックス コントロールを選択して、サブプロパティの一覧を展開または折りたたみます。 展開ボックス コントロールは、プラス記号 (+) または負符号 (-) を含む正方形で指定されます。 プラス記号は、プロパティを展開してサブプロパティの一覧を表示できることを示します。 負符号は、リストを折りたたんでプロパティのみを表示できることを示します。
CMFCPropertyGridProperty::OnDrawName
プロパティ名を表示するためにフレームワークによって呼び出されます。
virtual void OnDrawName(
CDC* pDC,
CRect rect);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
rect
[in]プロパティ名を描画する場所を指定する外接する四角形。
CMFCPropertyGridProperty::OnDrawValue
プロパティ値を表示するためにフレームワークによって呼び出されます
virtual void OnDrawValue(
CDC* pDC,
CRect rect);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
rect
[in]プロパティ値を描画する場所を指定する外接する四角形。
CMFCPropertyGridProperty::OnEdit
ユーザーがプロパティ値を変更しようとすると、フレームワークによって呼び出されます
virtual BOOL OnEdit(LPPOINT lptClick);
パラメーター
lptClick
[in](このパラメーターは使用されません)。ポイントへのポインター (クライアント座標)。
戻り値
TRUE 編集操作が正常に開始された場合。それ以外の場合は FALSE。
解説
この関数は、ユーザーがプロパティ値を変更しようとしているときにフレームワークによって呼び出されます。 既定では、このメソッドはコンボ ボックス コントロールまたはスピン コントロールに適したエディターを起動します。
CMFCPropertyGridProperty::OnEndEdit
ユーザーがプロパティ値の変更を完了したときにフレームワークによって呼び出されます。
virtual BOOL OnEndEdit();
戻り値
このメソッドは常に TRUE を返します。
解説
既定では、このメソッドは現在の編集コントロールを破棄し、 TRUEを返します。
CMFCPropertyGridProperty::OnKillFocus
プロパティが入力フォーカスを失ったときにフレームワークによって呼び出されます。
virtual BOOL OnKillFocus(CWnd*);
パラメーター
CWnd
[in](使用されていません。)ウィンドウへのポインター。
戻り値
このメソッドは常に TRUE を返します。
解説
既定では、このメソッドは何も実行せず、 TRUEを返します。 このメソッドをオーバーライドする場合は、プロパティが入力フォーカスを失ったときにフレームワークが編集操作を終了できる場合は、 TRUE を返します。
CMFCPropertyGridProperty::OnKillSelection
virtual void OnKillSelection(CMFCPropertyGridProperty*);
パラメーター
[入力] CMFCPropertyGridProperty*\
解説
既定では、このメソッドは何も実行しません。
CMFCPropertyGridProperty::OnPosSizeChanged
virtual void OnPosSizeChanged(CRect);
パラメーター
[入力] CRect\
解説
既定では、このメソッドは何も実行しません。
CMFCPropertyGridProperty::OnRClickName
ユーザーがプロパティ名領域でマウスの右ボタンを選択すると、フレームワークによって呼び出されます。
virtual void OnRClickName(CPoint C);
パラメーター
C
[in]ポイント (クライアント座標)。
解説
既定では、このメソッドは何も実行しません。
CMFCPropertyGridProperty::OnRClickValue
ユーザーがプロパティ値領域でマウスの右ボタンを選択すると、フレームワークによって呼び出されます。
virtual void OnRClickValue(
CPoint C,
BOOL B);
パラメーター
C
[in]ポイント (クライアント座標)。
B
[in]ブール値。
解説
既定では、このメソッドは何も行いません。 B パラメーターには定義済みの目的はありません。
CMFCPropertyGridProperty::OnSelectCombo
ユーザーが編集可能なコンボ ボックスから項目を選択すると、フレームワークによって呼び出されます。
virtual void OnSelectCombo();
解説
既定では、このメソッドは選択した項目のテキストを使用してプロパティ値を更新します。
CMFCPropertyGridProperty::OnSetCursor
マウス ポインターがプロパティ項目に移動したときにフレームワークによって呼び出されます。
virtual BOOL OnSetCursor() const;
戻り値
TRUE 現在のプロパティがバリアント型または値のリストである場合、このメソッドはカーソル (I ビーム) マウス カーソルを正常に読み込みます。それ以外の場合は FALSE。
解説
このメソッドは、 VT_INT、 VT_I2、 VT_I4、 VT_UINT、 VT_UI1、 VT_UI2、 VT_UI4、 VT_R4、 VT_R8、および VT_BSTRのバリアント型をサポートします。
CMFCPropertyGridProperty::OnSetSelection
virtual void OnSetSelection CMFCPropertyGridProperty*);
パラメーター
[入力] CMFCPropertyGridProperty*\
解説
既定では、このメソッドは何も実行しません。
CMFCPropertyGridProperty::OnUpdateValue
編集可能なプロパティの値が変更されると、フレームワークによって呼び出されます
virtual BOOL OnUpdateValue();
戻り値
TRUE このメソッドが成功した場合。それ以外の場合は FALSE。
CMFCPropertyGridProperty::PushChar
プロパティが選択され、ユーザーが新しい文字を入力したときに、プロパティ リスト コントロールから呼び出されます。
virtual BOOL PushChar(UINT nChar);
パラメーター
nChar
[in]文字。
戻り値
TRUE 編集操作が続行されている場合。それ以外の場合は FALSE。
解説
このメソッドは、値の一覧またはバリアント型 ( VT_INT、 VT_I2、 VT_I4、 VT_UINT、 VT_UI1、 VT_UI2、 VT_UI4、 VT_R4、 VT_R8、 VT_BSTR) のいずれかのプロパティをサポートします。
CMFCPropertyGridProperty::Redraw
プロパティを再描画します。
void Redraw();
CMFCPropertyGridProperty::RemoveAllOptions
プロパティからすべてのオプション (項目) を削除します。
void RemoveAllOptions();
解説
オプションは、プロパティ リスト コントロールのリスト アイテムとも呼ばれます。
CMFCPropertyGridProperty::RemoveSubItem
指定したサブ項目を削除します。
BOOL RemoveSubItem(
CMFCPropertyGridProperty*& pProp,
BOOL bDelete=TRUE);
パラメーター
pProp
[in]プロパティサブ項目へのポインター。
bDelete
[入力] TRUEpProp パラメーターで指定されたプロパティ オブジェクトを削除する場合は a0/>。それ以外の場合はFALSE。 既定値は TRUE です。
戻り値
解説
指定したサブ項目を移動する場合は、bDelete パラメーターにFALSEを指定します。つまり、サブ項目を削除してから、別の場所に追加します。
CMFCPropertyGridProperty::ResetOriginalValue
編集したプロパティの元の値を復元します。
virtual void ResetOriginalValue();
CMFCPropertyGridProperty::SetData
DWORD値をプロパティに関連付けます。
void SetData(DWORD_PTR dwData);
パラメーター
dwData
[in]整数や他のデータへのポインターなど、アプリケーション固有の 32 ビット値。
解説
DWORD値を取得するには、CMFCPropertyGridProperty::GetData メソッドを使用します。 CMFCPropertyGridCtrl::FindItemByData メソッドを使用して、指定したDWORD値に関連付けられているプロパティ リスト アイテムを見つけます。
CMFCPropertyGridProperty::SetDescription
現在のプロパティを説明するテキストを指定します。
void SetDescription(const CString& strDescr);
パラメーター
strDescr
[in]現在のプロパティを説明するテキスト。
CMFCPropertyGridProperty::SetName
プロパティの名前を設定します。
void SetName(
LPCTSTR lpszName,
BOOL bRedraw=TRUE);
パラメーター
lpszName
[in] プロパティ名。
bRedraw
[入力] TRUE プロパティを直ちに再描画する場合。それ以外の場合は FALSE。 既定値は TRUE です。
CMFCPropertyGridProperty::SetOriginalValue
編集可能なプロパティの元の値を設定します。
virtual void SetOriginalValue(const COleVariant& varValue);
パラメーター
varValue
[in]値。
解説
CMFCPropertyGridProperty::ResetOriginalValue メソッドを使用して、編集したプロパティの元の値をリセットします。
CMFCPropertyGridProperty::SetValue
プロパティ グリッド プロパティの値を設定します。
virtual void SetValue(const _variant_t& varValue);
パラメーター
varValue
[in]プロパティを設定する値への参照。
例: SetValue
void SetPropBarValue(UINT propId, const DWORD& barPropDwordValue)
{
auto property = propertiesGridCtrlList.FindItemByData(propId);
if (property != nullptr)
{
property->SetValue(static_cast<_variant_t >(barPropDwordValue == 1)); // set value to true or false depending on dword value
}
}
CMFCPropertyGridProperty::Show
プロパティを表示または非表示にします。
void Show(
BOOL bShow=TRUE,
BOOL bAdjustLayout=TRUE);
パラメーター
bShow
[入力] TRUE 現在のプロパティとそのサブ項目を表示する場合。現在のプロパティとそのサブ項目を非表示にする FALSE します。 既定値は TRUE です。
bAdjustLayout
[入力] TRUE プロパティのラベルと値を描画し、プロパティを描画する方法を再計算する。既存の計算を使用してプロパティを描画 FALSE 。 既定値は TRUE です。