CPropertySheet クラス

[アーティクル]
02/21/2013

タブダイアログボックスとしても知られるプロパティシートを表します。

class CPropertySheet : public CWnd

メンバー

パブリックコンストラクター

名前	説明
CPropertySheet::CPropertySheet	CPropertySheet オブジェクトを構築します。

パブリックメソッド

名前	説明
CPropertySheet::AddPage	プロパティシートにページを追加します。
CPropertySheet::Construct	CPropertySheet オブジェクトを構築します。
CPropertySheet::Create	モードレスプロパティシートを表示します。
CPropertySheet::DoModal	モーダルのプロパティシートを表示します。
CPropertySheet::EnableStackedTabs	プロパティシートが左右に並べて表示またはスクロールタブを使用するかどうかを示します。
CPropertySheet::EndDialog	プロパティシートを終了します。
CPropertySheet::GetActiveIndex	プロパティシートのアクティブなページのインデックスを取得します。
CPropertySheet::GetActivePage	アクティブページのオブジェクトを返します。
CPropertySheet::GetPage	指定したページへのポインターを取得します。
CPropertySheet::GetPageCount	プロパティシートのページ数を取得します。
CPropertySheet::GetPageIndex	プロパティシートの指定したページのインデックスを取得します。
CPropertySheet::GetTabControl	タブコントロールへのポインターを取得します。
CPropertySheet::MapDialogRect	四角形のダイアログボックス単位を単位を除外するに変換します。
CPropertySheet::OnInitDialog	プロパティシートの初期化処理を拡張するためにオーバーライドします。
CPropertySheet::PressButton	プロパティシートの指定したボタンのクリックをシミュレートします。
CPropertySheet::RemovePage	プロパティシートからページを削除します。
CPropertySheet::SetActivePage	プログラムでアクティブページのオブジェクトを設定します。
CPropertySheet::SetFinishText	完了のボタンのテキストを設定します。
CPropertySheet::SetTitle	プロパティシートキャプションを設定します。
CPropertySheet::SetWizardButtons	ウィザードのボタンを有効にします。
CPropertySheet::SetWizardMode	ウィザードモードを有効にします。

パブリックデータメンバー

名前	説明
CPropertySheet::m_psh	Windows の構造 PROPSHEETHEADER。基本プロパティシートのパラメーターへのアクセスを提供します。

解説

プロパティシートは、1 つの CPropertySheet オブジェクトと、1 つ以上の CPropertyPage オブジェクトで構成されます。フレームワークは、一連のタブインデックスを持ち、現在選択されているページが表示される領域のあるウィンドウとしてプロパティシートを表示します。ユーザーは、該当するタブを使用して特定のページに移動します。

CPropertySheet では、Windows 98 および Windows NT 2000 で導入された、拡張 PROPSHEETHEADER 構造体がサポートされています。この構造体には、"ウォーターマーク" の背景ビットマップの使用をサポートする追加のフラグとメンバーが含まれます。

この新しいイメージをプロパティシートオブジェクトに自動的に表示するには、CPropertySheet::Construct または CPropertySheet::CPropertySheet を呼び出し、ビットマップイメージとパレットイメージの有効な値を渡します。

CPropertySheet は CDialog から派生されてはいませんが、CPropertySheet オブジェクトの管理は、CDialog オブジェクトの管理と同じように行われます。たとえば、プロパティシートの作成は 2 段階で行われます。まずコンストラクターを呼び出し、次に、モーダルプロパティシートでは DoModal を、モードレスプロパティシートでは Create を呼び出します。CPropertySheet には、CPropertySheet::Construct と CPropertySheet::CPropertySheet の 2 種類のコンストラクターがあります。

CPropertySheet オブジェクトを構築するときに、一部のウィンドウスタイルによって初回例外が発生する可能性があります。これは、まだ作成されていないプロパティシートのスタイルをシステムが変更しようとするために起こります。この例外を回避するには、独自の CPropertySheet を作成するときに次のスタイルを設定してください。

DS_3DLOOK
DS_CONTROL
WS_CHILD
WS_TABSTOP

次のオプションのスタイルも、初回例外を引き起こすことなく使用できます。

DS_SHELLFONT
DS_LOCALEDIT
WS_CLIPCHILDREN

これ以外の Window Styles は禁止されているので、有効にしないでください。

CPropertySheet オブジェクトと外部オブジェクトの間でのデータの交換は、CDialog オブジェクトとのデータ交換に似ています。大きな違いは、プロパティシートの設定は、通常、CPropertySheet オブジェクト自身のメンバー変数ではなく、CPropertyPage オブジェクトのメンバー変数になっているという点です。

ウィザードと呼ばれる型のタブダイアログボックスを作成できます。このダイアログボックスは、デバイスのセットアップやニュースレターの作成のような、操作の手順をユーザーに示す一連のプロパティページを持つプロパティシートで構成されています。ウィザード型のタブダイアログボックスでは、プロパティページにタブがなく、一度に 1 つのプロパティページだけが表示されます。また、ウィザード型のタブダイアログボックスは、[OK] ボタンや [今すぐ適用] ボタンの代わりに、[戻る]、[次へ]、[完了]、[キャンセル]、および [ヘルプ] の各ボタンを持ちます。

ウィザード型ダイアログボックスを作成する手順は、標準のプロパティシートの作成手順と同じですが、DoModal を呼び出す前に、SetWizardMode を呼び出します。ウィザードボタンを有効にするには、その機能や外観をカスタマイズするためのフラグを使って SetWizardButtons を呼び出します。[完了] ボタンを有効にするには、ウィザードの最後のページでユーザーが操作を行った後に SetFinishText を呼び出します。

CPropertySheet オブジェクトの使い方の詳細については、「プロパティシートとプロパティページ」を参照してください。また、サポート技術情報の「HOWTO: Create a Modeless CPropertySheet with Standard Buttons (Q146916)」および「HOWTO: Design a Resizable MFC Property Sheet (Q300606)」も参照してください。