プロパティページの追加 (ATL チュートリアル、パート 6)

[アーティクル]
04/03/2023

Note

ATL OLE DB プロバイダーウィザードは、Visual Studio 2019 以降では使用できません。

プロパティページは個別の COM オブジェクトとして実装されるため、必要に応じて共有することができます。この手順では、次のタスクを行ってプロパティページをコントロールに追加します。

プロパティページのリソースを作成する
コードを追加してプロパティページを作成および管理する
プロパティページをコントロールに追加する

プロパティページのリソースを作成する

プロパティページをコントロールに追加するには、ATL プロパティページテンプレートを使用します。

プロパティページを追加するには

ソリューションエクスプローラーで Polygon を右クリックします。
ショートカットメニューの [追加]>[新しい項目] をクリックします。
テンプレートの一覧で [ATL]>[ATL プロパティページ] を選択し、[追加] をクリックします。
ATL プロパティページウィザードが表示されたら、短い名前として「PolyProp」と入力します。
[文字列] をクリックして [文字列] ページを開き、タイトルとして「&Polygon」と入力します。

プロパティページのタイトルは、そのページのタブに表示される文字列です。 ドキュメント文字列は、プロパティフレームのステータス行またはツールヒントに表示される説明です。標準のプロパティフレームでは現在この文字列が使用されないため、既定の内容のままにすることができる点に注意してください。現時点ではヘルプファイルを生成しないので、そのテキストボックス内のエントリを削除します。
[完了] をクリックすると、プロパティページオブジェクトが作成されます。

次の 3 つのファイルが作成されます。

ファイル	説明
PolyProp.h	プロパティページを実装する C++クラス `CPolyProp` が含まれています。
PolyProp.cpp	PolyProp.h ファイルが含まれています。
PolyProp.rgs	プロパティページオブジェクトを登録するレジストリスクリプトです。

次のコード変更も行われます。

新しいプロパティページが Polygon.cpp のオブジェクトエントリマップに追加されます。
PolyProp クラスが Polygon.idl ファイルに追加されます。
新しいレジストリスクリプトファイル PolyProp.rgs がプロジェクトのリソースに追加されます。
ダイアログボックスのテンプレートがプロパティページのプロジェクトのリソースに追加されます。
指定したプロパティの文字列がリソース文字列テーブルに追加されます。

次に、プロパティページに表示するフィールドを追加します。

プロパティページにフィールドを追加するには

ソリューションエクスプローラーで Polygon.rc リソースファイルをダブルクリックします。これにより、リソースビューが開きます。
リソースビューで Dialog ノードを展開し、IDD_POLYPROP をダブルクリックします。表示されるダイアログボックスは空白で、コントロールを挿入する場所を示すラベルだけが表示されていることに注意してください。
そのラベルを選択して Sides: に変更します。これには、[プロパティ] ウィンドウ内の [キャプション] のテキストを変更します。
テキストのサイズに合わせてラベルボックスのサイズを変更します。
ツールボックスからラベルの右側に編集コントロールをドラッグします。
最後に、[プロパティ] ウィンドウを使用して編集コントロールの ID を IDC_SIDES に変更します。

これで、プロパティページのリソースを作成するプロセスが完了します。

コードを追加してプロパティページを作成および管理する

プロパティページのリソースを作成したので、実装コードを記述する必要があります。

まず、CPolyProp クラスを有効にして、[適用] ボタンが押されたときのオブジェクトの側面の数を設定します。

Apply 関数を変更して側面の数を設定するには

PolyProp.h の Apply 関数を次のコードに置き換えます。

STDMETHOD(Apply)(void)
{
   USES_CONVERSION;
   ATLTRACE(_T("CPolyProp::Apply\n"));
   for (UINT i = 0; i < m_nObjects; i++)
   {
      CComQIPtr<IPolyCtl, &IID_IPolyCtl> pPoly(m_ppUnk[i]);
      short nSides = (short)GetDlgItemInt(IDC_SIDES);
      if FAILED(pPoly->put_Sides(nSides))
      {
         CComPtr<IErrorInfo> pError;
         CComBSTR strError;
         GetErrorInfo(0, &pError);
         pError->GetDescription(&strError);
         MessageBox(OLE2T(strError), _T("Error"), MB_ICONEXCLAMATION);
         return E_FAIL;
      }
   }
   m_bDirty = FALSE;
   return S_OK;
}

プロパティページには同時に複数のクライアントをアタッチできるため、Apply 関数は繰り返し実行し、編集ボックスから取得した値を持つ各クライアントに対して put_Sides を呼び出します。ここで使用している CComQIPtr クラスは、各オブジェクトに対して QueryInterface を実行し、(m_ppUnk 配列に格納されている) IUnknown インターフェイスから IPolyCtl インターフェイスを取得します。

このコードは、この段階で Sides プロパティの設定が実際に行われたかどうかをチェックします。失敗していた場合、コードはメッセージボックスを表示して、IErrorInfo インターフェイスからのエラーの詳細を表示します。通常、コンテナーはまずオブジェクトに ISupportErrorInfo インターフェイスを要求して InterfaceSupportsErrorInfo を呼び出し、そのオブジェクトでエラー情報の設定がサポートされているかどうかを確認します。このタスクは省略できます。

CComPtr によって参照カウントが自動的に処理されるため、インターフェイスで Release を呼び出す必要がありません。 CComBSTR では BSTR の処理が行われるため、最後に SysFreeString の呼び出しを実行する必要がありません。また、さまざまな文字列変換クラスのいずれかを使用して、BSTR を必要に応じて変換することができます (これが、関数の先頭に USES_CONVERSION マクロがある理由です)。

さらに、プロパティページのダーティーフラグを設定し、[適用] ボタンを有効にする必要があることを示す必要があります。これは、ユーザーが [側面] 編集ボックスの値を変更したときに発生します。

[適用] ボタンを処理するには

クラスビューで CPolyProp を右クリックし、ショートカットメニューの [プロパティ] をクリックします。
[プロパティ] ウィンドウの [イベント] アイコンをクリックします。
イベント一覧で IDC_SIDES ノードを展開します。
EN_CHANGE を選択し、右側のドロップダウンメニューで <[追加] > [OnEnChangeSides] をクリックします。 OnEnChangeSides ハンドラーの宣言が Polyprop.h に、ハンドラーの実装が Polyprop.cpp に追加されます。

次に、ハンドラーを変更します。

OnEnChangeSides メソッドを変更するには

Polyprop.cpp の次のコードを OnEnChangeSides メソッドに追加します (ウィザードによって配置されているコードはすべて削除します)。
```
LRESULT CPolyProp::OnEnChangeSides(WORD /*wNotifyCode*/, WORD /*wID*/, 
   HWND /*hWndCtl*/, BOOL& /*bHandled*/)
{
   SetDirty(TRUE);

   return 0;
}
```

IDC_SIDES コントロールの EN_CHANGE の通知とともに WM_COMMAND メッセージが送信されるときに、OnEnChangeSides が呼び出されます。その後 OnEnChangeSides は SetDirty を呼び出して TRUE を渡し、プロパティページがダーティになり、[適用] ボタンを有効にする必要があることを示します。

プロパティページをコントロールに追加する

プロジェクトには複数のコントロールがある可能性があるため、ATL プロパティページのテンプレートやウィザードによって、コントロールにプロパティページが自動的に追加されることはありません。コントロールのプロパティマップにエントリを追加する必要があります。

プロパティページを追加するには

PolyCtl.h を開き、次の行をプロパティマップに追加します。
```
PROP_ENTRY_TYPE("Sides", 1, CLSID_PolyProp, VT_INT)
PROP_PAGE(CLSID_PolyProp)
```

コントロールのプロパティマップは次のようになります。

BEGIN_PROP_MAP(CPolyCtl)
   PROP_DATA_ENTRY("_cx", m_sizeExtent.cx, VT_UI4)
   PROP_DATA_ENTRY("_cy", m_sizeExtent.cy, VT_UI4)
#ifndef _WIN32_WCE
   PROP_ENTRY_TYPE("FillColor", DISPID_FILLCOLOR, CLSID_StockColorPage, VT_UI4)
#endif
   PROP_ENTRY_TYPE("Sides", 1, CLSID_PolyProp, VT_INT)
   PROP_PAGE(CLSID_PolyProp)
   // Example entries
   // PROP_ENTRY("Property Description", dispid, clsid)
   // PROP_PAGE(CLSID_StockColorPage)
END_PROP_MAP()

プロパティページの CLSID を使用して PROP_PAGE マクロを追加する方法もありますが、上記のように PROP_ENTRY マクロを使用すると、コントロールの保存時に Sides プロパティの値も保存されます。

このマクロへの 3 つのパラメーターは、プロパティの説明、プロパティの DISPID、そのプロパティを持つプロパティページの CLSID です。これが役に立つのは、たとえば Visual Basic にコントロールを読み込み、設計時に側面の数を設定する場合です。側面の数を保存すると、Visual Basic プロジェクトを再読み込みするときに側面の数が復元されるからです。

コントロールのビルドとテスト

次は、このコントロールをビルドし、ActiveX コントロールテストコンテナーに挿入します。 テストコンテナーの [編集] メニューで、[PolyCtl クラスオブジェクト] をクリックします。プロパティページが開き、追加した情報が表示されます。

[適用] ボタンは最初は無効になっています。 [側面] ボックスで値の入力を開始すると、[適用] ボタンが有効になります。値の入力が完了したら、[適用] ボタンをクリックします。コントロールの表示が変化して、[適用] ボタンが再び無効になります。無効な値を入力してみてください。メッセージボックスが開き、put_Sides 関数で設定したエラーの説明が表示されます。

次は、コントロールを Web ページに配置します。

手順 5 に戻る | 手順 7 に進む

プロパティページの追加 (ATL チュートリアル、パート 6)

プロパティページのリソースを作成する

プロパティページを追加するには

プロパティページにフィールドを追加するには

コードを追加してプロパティページを作成および管理する

Apply 関数を変更して側面の数を設定するには

[適用] ボタンを処理するには

OnEnChangeSides メソッドを変更するには

プロパティページをコントロールに追加する

プロパティページを追加するには

コントロールのビルドとテスト

関連項目

フィードバック

フィードバック

その他のリソース

プロパティ ページの追加 (ATL チュートリアル、パート 6)

プロパティ ページのリソースを作成する

プロパティ ページを追加するには

プロパティ ページにフィールドを追加するには

コードを追加してプロパティ ページを作成および管理する

Apply 関数を変更して側面の数を設定するには

[適用] ボタンを処理するには

OnEnChangeSides メソッドを変更するには

プロパティ ページをコントロールに追加する

プロパティ ページを追加するには

コントロールのビルドとテスト

関連項目

フィードバック

フィードバック

その他のリソース

プロパティページの追加 (ATL チュートリアル、パート 6)

プロパティページのリソースを作成する

プロパティページを追加するには

プロパティページにフィールドを追加するには

コードを追加してプロパティページを作成および管理する

プロパティページをコントロールに追加する

プロパティページを追加するには