手順 6: プロパティページの追加

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

更新 : 2007 年 11 月

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

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

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

コントロールにプロパティページを追加するには、クラスの追加ウィザードを使用します。

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

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

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

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

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

コードも次のように変更されます。

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

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

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

ソリューションエクスプローラで、Polygon.rc リソースファイルをダブルクリックします。リソースビューが表示されます。
リソースビューで、[Dialog] ノードを展開し、[IDD_POLYPROP] をダブルクリックします。表示されるダイアログボックスには、コントロールの挿入を指示するラベルだけが表示されています。
そのラベルを選択し、[プロパティ] ウィンドウの [Caption] のテキストを変更し、ラベルボックスのサイズを変更して、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;
}
```

OnEnChangeSides は、WM_COMMAND メッセージが IDC_SIDES コントロールの EN_CHANGE 通知と共に送られたときに呼び出されます。OnEnChangeSides は SetDirty を呼び出して TRUE を渡し、プロパティページに変更が加えられているため [適用] ボタンを有効にする必要があることを知らせます。

コントロールへのプロパティページの追加

プロジェクト内に複数のコントロールが存在することがあるため、クラスの追加ウィザードおよび ATL プロパティページウィザードでは、プロパティページは自動的にはコントロールに追加されません。コントロールのプロパティマップにエントリを追加する必要があります。

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

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

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

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)
   // 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 に読み込んで、デザイン時に Sides の数を設定する場合に便利です。Sides の数が保存されるため、Visual Basic プロジェクトを再読み込みしたときに、Sides の数が復元されます。

コントロールのビルドと動作確認

ここで、コントロールをビルドし、ActiveX コントロールテストコンテナに挿入します。テストコンテナで、[編集] メニューの [PolyCtl Class オブジェクト] をクリックします。プロパティページが表示されたら、[多角形 (P)] タブをクリックします。

最初は、[適用] ボタンが無効になっています。[サイド] ボックスへの値の入力を始めると、[適用] ボタンが有効になります。値の入力が終了したら、[適用] ボタンをクリックします。コントロールの表示が変わり、[適用] ボタンは再び無効になります。無効な値の入力を試してください。put_Sides 関数で設定したエラーの詳細を示すメッセージボックスが表示されます。

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

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

参照

ATL チュートリアル

次の方法で共有

手順 6: プロパティページの追加

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

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

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

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

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

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

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

コントロールへのプロパティページの追加

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

コントロールのビルドと動作確認

参照

参照

その他のリソース

次の方法で共有

手順 6: プロパティ ページの追加

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

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

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

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

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

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

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

コントロールへのプロパティ ページの追加

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

コントロールのビルドと動作確認

参照

参照

その他のリソース

手順 6: プロパティページの追加

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

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

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

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

コントロールへのプロパティページの追加

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