`CPropertySheet` クラス

[アーティクル]
07/05/2024

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

構文

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` 構造体。基本的なプロパティシートパラメーターへのアクセスを提供します。

解説

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

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

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

CPropertySheetはCDialogから派生したものではありませんが、CPropertySheet オブジェクトの管理は、CDialog オブジェクトの管理に似ています。たとえば、プロパティシートを作成するには、コンストラクターを呼び出し、モーダルプロパティシートの DoModal を呼び出すか、モードレスプロパティシートの Create を呼び出すという 2 部構成が必要です。 CPropertySheet には、 CPropertySheet::Construct と CPropertySheet::CPropertySheet の 2 種類のコンストラクターがあります。

CPropertySheet オブジェクトを作成すると、一部のWindow スタイルが原因で初回例外が発生する可能性があります。これは、システムがシートを作成する前にプロパティシートのスタイルを変更しようとした結果です。この例外を回避するには、 CPropertySheetを作成するときに、必ず次のスタイルを設定してください。

DS_3DLOOK
DS_CONTROL
WS_CHILD
WS_TABSTOP

次のスタイルは省略可能であり、初回例外は発生しません。

DS_SHELLFONT
DS_LOCALEDIT
WS_CLIPCHILDREN

その他の Window Styles は禁止されており、有効にしないでください。

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

ウィザードと呼ばれるタブダイアログボックスの種類を作成できます。このダイアログボックスは、デバイスの設定やニュースレターの作成など、操作の手順をユーザーに案内する一連のプロパティページを含むプロパティシートで構成されます。ウィザードの種類のタブダイアログボックスでは、プロパティページにタブは表示されず、一度に表示されるプロパティページは 1 つだけです。また、 OK と Apply Now ボタンの代わりに、ウィザードの種類のタブダイアログボックスには、 Back ボタン、 Next または Finish ボタン、 Cancel ボタン、および Help ボタンがあります。

ウィザードの種類のダイアログボックスを作成するには、標準のプロパティシートを作成する場合と同じ手順に従いますが、DoModalを呼び出す前にSetWizardModeを呼び出します。ウィザードボタンを有効にするには、フラグを使用して SetWizardButtonsを呼び出し、その機能と外観をカスタマイズします。 Finish ボタンを有効にするには、ユーザーがウィザードの最後のページでアクションを実行した後、SetFinishTextを呼び出します。

CPropertySheet オブジェクトの使用方法の詳細については、「プロパティシートとプロパティページ」を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CPropertySheet

要件

ヘッダー: afxdlgs.h

`CPropertySheet::AddPage`

指定したページをプロパティシートの右端のタブに追加します。

void AddPage(CPropertyPage* pPage);

パラメーター

pPage
プロパティシートに追加するページをポイントします。 NULL にすることはできません。

解説

ページを表示する左から右の順序でプロパティシートにページを追加します。

AddPage は、 CPropertyPage オブジェクトを CPropertySheet オブジェクトのページの一覧に追加しますが、実際にはページのウィンドウは作成しません。フレームワークは、ユーザーがそのページを選択するまで、ページのウィンドウの作成を延期します。

AddPageを使用してプロパティページを追加する場合、CPropertySheetはCPropertyPageの親になります。プロパティページからプロパティシートにアクセスするには、 CWnd::GetParentを呼び出します。

プロパティシートウィンドウを作成して AddPageを呼び出すまで待つ必要はありません。通常、DoModalまたはCreateを呼び出す前に、AddPageを呼び出します。

プロパティページを表示した後 AddPage を呼び出すと、タブ行に新しく追加されたページが反映されます。

例

// Add three pages to a CPropertySheet object, then show the 
// CPropertySheet object as a modal dialog.  CStylePage, CShapePage,  
// and CColorPage are CPropertyPage-derived classes created 
// by the Add Class wizard.  

CPropertySheet dlgPropertySheet(_T("Simple PropertySheet"));

CStylePage     stylePage;
CColorPage     colorPage;
CShapePage     shapePage;
dlgPropertySheet.AddPage(&stylePage);
dlgPropertySheet.AddPage(&colorPage);
dlgPropertySheet.AddPage(&shapePage);

dlgPropertySheet.DoModal();

`CPropertySheet::Construct`

CPropertySheet オブジェクトを構築します。

void Construct(
    UINT nIDCaption,
    CWnd* pParentWnd = NULL,
    UINT iSelectPage = 0);

void Construct(
    LPCTSTR pszCaption,
    CWnd* pParentWnd = NULL,
    UINT iSelectPage = 0);

void Construct(
    UINT nIDCaption,
    CWnd* pParentWnd,
    UINT iSelectPage,
    HBITMAP hbmWatermark,
    HPALETTE hpalWatermark = NULL,
    HBITMAP hbmHeader = NULL);

void Construct(
    LPCTSTR pszCaption,
    CWnd* pParentWnd,
    UINT iSelectPage,
    HBITMAP hbmWatermark,
    HPALETTE hpalWatermark = NULL,
    HBITMAP hbmHeader = NULL);

パラメーター

nIDCaption
プロパティシートに使用するキャプションの ID。

pParentWnd
プロパティシートの親ウィンドウへのポインター。 NULL場合、親ウィンドウはアプリケーションのメインウィンドウになります。

iSelectPage
最初に上部に表示されるページのインデックス。既定値は、シートに追加された最初のページです。

pszCaption
プロパティシートに使用するキャプションを含む文字列へのポインター。 NULL にすることはできません。

hbmWatermark
プロパティページの透かしビットマップを処理します。

hpalWatermark
透かしビットマップやヘッダービットマップのパレットを処理します。

hbmHeader
プロパティページのヘッダービットマップへのハンドル。

解説

クラスコンストラクターの 1 つがまだ呼び出されていない場合は、このメンバー関数を呼び出します。たとえば、CPropertySheet オブジェクトの配列を宣言または割り当てるときに、Constructを呼び出します。配列の場合は、配列内のメンバーごとに Construct を呼び出す必要があります。

プロパティシートを表示するには、 DoModal または Createを呼び出します。最初のパラメーターに含まれる文字列は、プロパティシートのキャプションバーに配置されます。

上記の Constructの 3 番目または 4 番目のプロトタイプを使用し、 hbmWatermark、 hpalWatermark、または hbmHeader パラメーターに有効な値を渡すと、透かしやヘッダー画像を自動的に表示できます。

例

次の例は、 Constructと呼ぶ状況を示しています。

const int c_cSheets = 3;
CPropertySheet   grpropsheet[c_cSheets];
// no need to call Construct for this next one
CPropertySheet   someSheet(_T("Some sheet"));

LPTSTR rgszSheets[c_cSheets] = {
   _T("Sheet 1"),
   _T("Sheet 2"),
   _T("Sheet 3")
};

for (int i = 0; i < c_cSheets; i++)
   grpropsheet[i].Construct(rgszSheets[i]);

`CPropertySheet::CPropertySheet`

CPropertySheet オブジェクトを構築します。

CPropertySheet();

explicit CPropertySheet(
    UINT nIDCaption,
    CWnd* pParentWnd = NULL,
    UINT iSelectPage = 0);

explicit CPropertySheet(
    LPCTSTR pszCaption,
    CWnd* pParentWnd = NULL,
    UINT iSelectPage = 0);

CPropertySheet(
    UINT nIDCaption,
    CWnd* pParentWnd,
    UINT iSelectPage,
    HBITMAP hbmWatermark,
    HPALETTE hpalWatermark = NULL,
    HBITMAP hbmHeader = NULL);

CPropertySheet(
    LPCTSTR pszCaption,
    CWnd* pParentWnd,
    UINT iSelectPage,
    HBITMAP hbmWatermark,
    HPALETTE hpalWatermark = NULL,
    HBITMAP hbmHeader = NULL);

パラメーター

nIDCaption
プロパティシートに使用するキャプションの ID。

pParentWnd
プロパティシートの親ウィンドウをポイントします。 NULL場合、親ウィンドウはアプリケーションのメインウィンドウになります。

iSelectPage
最初に上部に表示されるページのインデックス。既定値は、シートに追加された最初のページです。

pszCaption
プロパティシートに使用するキャプションを含む文字列を指します。 NULL にすることはできません。

hbmWatermark
プロパティシートの背景ビットマップへのハンドル。

hpalWatermark
透かしビットマップまたはヘッダービットマップのパレットへのハンドル。

hbmHeader
プロパティページのヘッダービットマップへのハンドル。

解説

複数のパラメーターがある場合 (配列を使用している場合など)、CPropertySheetの代わりにConstructを使用します。

上記の CPropertySheetの 3 番目または 4 番目のプロトタイプを使用し、 hbmWatermark、 hpalWatermark、または hbmHeader パラメーターに有効な値を渡すと、透かしやヘッダー画像を自動的に表示できます。

例

// Declare a CPropertySheet object titled "Simple PropertySheet".
CPropertySheet dlgPropertySheet1(_T("Simple PropertySheet"));

// Declare a CPropertySheet object whose title is specified in the
// IDS_PROPERTYSHEET_TITLE string resource, and the second page is
// initially on top.  
CPropertySheet dlgPropertySheet2(IDS_PROPERTYSHEET_TITLE, this, 1);

`CPropertySheet::Create`

モードレスプロパティシートを表示します。

virtual BOOL Create(CWnd* pParentWnd = NULL,
    DWORD dwStyle = (DWORD)-1,
    DWORD dwExStyle = 0);

パラメーター

pParentWnd
親ウィンドウをポイントします。 NULL場合、親はデスクトップです。

dwStyle
プロパティシートのウィンドウスタイル。使用可能なスタイルの完全な一覧については、「 Window スタイル」を参照してください。

dwExStyle
プロパティシートの拡張ウィンドウスタイル。使用可能なスタイルの完全な一覧については、「目的のウィンドウスタイル」を参照してください。

戻り値

プロパティシートが正常に作成された場合は 0 以外。それ以外の場合は 0。

解説

Createの呼び出しは、コンストラクター内に配置することも、コンストラクターの呼び出し後に呼び出すこともできます。

Createメンバー関数は、プロパティシートを作成した直後に返されます。プロパティシートを破棄するには、 CWnd::DestroyWindowを呼び出します。

モードレスプロパティシートが表示され、モーダルプロパティシートと同様に、 Create の呼び出しに [OK]、[キャンセル]、[今すぐ適用]、および [ヘルプ] ボタンがありません。必要なボタンは、ユーザーが作成する必要があります。

モーダルプロパティシートを表示するには、代わりに DoModal を呼び出します。

例

// This code fragment shows how to create a modeless property sheet 
// dialog in a command message handler (OnModelessPropertySheet()) 
// of a CView-derived class.
void CPSheetView::OnModelessPropertySheet()
{
   // Declare a CPropertySheet object.  m_pdlgPropertySheet is a data
   // member of type CPropertySheet in CView-derived class.
   m_pdlgPropertySheet = new CPropertySheet(_T("Simple PropertySheet"));
   ASSERT(m_pdlgPropertySheet);

   // Add three pages to the CPropertySheet object.  Both m_pstylePage, 
   // m_pcolorPage, and m_pshapePage are data members of type 
   // CPropertyPage-derived classes in CView-derived class.
   m_pstylePage = new CStylePage;
   m_pcolorPage = new CColorPage;
   m_pshapePage = new CShapePage;
   m_pdlgPropertySheet->AddPage(m_pstylePage);
   m_pdlgPropertySheet->AddPage(m_pcolorPage);
   m_pdlgPropertySheet->AddPage(m_pshapePage);

   // Create a modeless CPropertySheet dialog.
   m_pdlgPropertySheet->Create();
}

// The code fragment below shows how to destroy the C++ objects for
// propertysheet and propertypage in the destructor of CView-derived
// class.
// NOTE:  DestroyWindow() is called in CPropertySheet::OnClose() so
// you do not need to call it here.  Property pages are children
// of the CPropertySheet, they will be destroyed by their parents.
CPSheetView::~CPSheetView()
{
   delete m_pshapePage;
   delete m_pstylePage;
   delete m_pcolorPage;
   delete m_pdlgPropertySheet;
}

`CPropertySheet::DoModal`

モーダルプロパティシートを表示します。

virtual INT_PTR DoModal();

戻り値

IDOK または、関数が成功した場合は IDCANCEL 。それ以外の場合は 0 または -1。プロパティシートがウィザードとして確立されている場合 ( SetWizardModeを参照)、 DoModal は ID_WIZFINISH または IDCANCELを返します。

解説

戻り値は、プロパティシートを閉じたコントロールの ID に対応します。この関数が戻ると、プロパティシートとすべてのページに対応するウィンドウが破棄されます。オブジェクト自体は引き続き存在します。通常は、IDOK を返した後、DoModalCPropertyPage オブジェクトからデータを取得します。

モードレスプロパティシートを表示するには、代わりに Create を呼び出します。

対応するダイアログリソースからプロパティページが作成されると、初回例外が発生する可能性があります。これは、プロパティページがダイアログリソースのスタイルを、ページが作成される前に必要なスタイルに変更した結果です。通常、リソースは読み取り専用であるため、例外が発生します。システムは例外を処理し、変更されたリソースのコピーを作成します。したがって、初回例外は無視できます。

Note

非同期例外処理モデルを使用してコンパイルする場合は、この例外をオペレーティングシステムで処理する必要があります。例外処理モデルの詳細については、「 /EH (例外処理モデル)」を参照してください。この場合、 CPropertySheet::DoModal への呼び出しを、catch がすべての例外 ( catch (...) など) を処理する C++ try-catch ブロックでラップしないでください。このブロックは、オペレーティングシステムを対象とした例外を処理し、予期しない動作を引き起こします。ただし、アクセス違反例外がオペレーティングシステムに渡される特定の例外の種類または構造化例外処理では、C++ 例外処理を安全に使用できます。

この初回例外が生成されないようにするには、プロパティシートに正しい Window スタイルがあることを手動で保証します。プロパティシートには、次のスタイルを設定する必要があります。

DS_3DLOOK
DS_CONTROL
WS_CHILD
WS_TABSTOP

初回例外を発生させずに、次の省略可能なスタイルを使用できます。

DS_SHELLFONT
DS_LOCALEDIT
WS_CLIPCHILDREN

プロパティシートと互換性がないため、他のすべての Windows スタイルを無効にします。このアドバイスは、拡張スタイルには適用されません。これらの標準スタイルを適切に設定すると、プロパティシートを変更する必要がないようにし、初回例外の生成を回避できます。

例

CPropertySheet::AddPage の例を参照してください。

`CPropertySheet::EnableStackedTabs`

プロパティシート内のタブの行をスタックするかどうかを示します。

void EnableStackedTabs(BOOL bStacked);

パラメーター

bStacked
プロパティシートで積み上げタブが有効かどうかを示します。 bStackedを FALSE に設定して、タグの積み重ね行を無効にします。

解説

既定では、プロパティシートにプロパティシートの幅の 1 行に収まるタブよりも多くのタブがある場合、タブは複数の行に積み重ねられます。タブを積み重ねる代わりにスクロールタブを使用するには、DoModalまたはCreateを呼び出す前に、bStackedを FALSE に設定してEnableStackedTabsを呼び出します。

モーダルプロパティシートまたはモードレスプロパティシートを作成するときは、 EnableStackedTabs を呼び出す必要があります。このスタイルを CPropertySheet派生クラスに組み込むには、 WM_CREATEのメッセージハンドラーを記述します。オーバーライドされたバージョンの CWnd::OnCreateで、基底クラスの実装を呼び出す前に EnableStackedTabs( FALSE ) を呼び出します。

例

int CMyPropertySheet::OnCreate(LPCREATESTRUCT lpCreateStruct)
{
   // Set for Scrolling Tabs style
   EnableStackedTabs(FALSE);
   // Call the base class
   if (CPropertySheet::OnCreate(lpCreateStruct) == -1)
      return -1;

   return 0;
}

`CPropertySheet::EndDialog`

プロパティシートを終了します。

void EndDialog(int nEndID);

パラメーター

nEndID
プロパティシートの戻り値として使用する識別子。

解説

このメンバー関数は、[OK]、[キャンセル]、または [閉じる] ボタンが押されたときにフレームワークによって呼び出されます。プロパティシートを閉じるイベントが発生した場合は、このメンバー関数を呼び出します。

このメンバー関数は、モーダルダイアログボックスでのみ使用されます。

例

CPropertySheet::PressButton の例を参照してください。

`CPropertySheet::GetActiveIndex`

プロパティシートウィンドウのアクティブなページのインデックス番号を取得し、返されたインデックス番号を GetPageのパラメーターとして使用します。

int GetActiveIndex() const;

戻り値

アクティブなページのインデックス番号。

例

CPropertySheet::GetActivePage の例を参照してください。

`CPropertySheet::GetActivePage`

プロパティシートウィンドウのアクティブなページを取得します。

CPropertyPage* GetActivePage() const;

戻り値

アクティブなページへのポインター。

解説

このメンバー関数を使用して、アクティブなページで何らかのアクションを実行します。

例

// The code fragment below sets the last active page (i.e. the 
// active page when the propertysheet was closed) to be the first 
// visible page when the propertysheet is shown. The last active 
// page was saved in m_LastActivePage, (a member variable of 
// CDocument-derived class) when OK was selected from the 
// propertysheet. CMyPropertySheet is a CPropertySheet-derived class.
BOOL CMyPropertySheet::OnInitDialog()
{
   BOOL bResult = CPropertySheet::OnInitDialog();

   CMDIFrameWnd* pframe = (CMDIFrameWnd*)AfxGetMainWnd();
   CMDIChildWnd* pchild = pframe->MDIGetActive();
   CPSheetDoc* doc = (CPSheetDoc*)pchild->GetActiveDocument();
   SetActivePage(doc->m_LastActivePage);

   return bResult;
}

BOOL CMyPropertySheet::OnCommand(WPARAM wParam, LPARAM lParam)
{
   if (LOWORD(wParam) == IDOK)
   {
      CMDIFrameWnd* pframe = (CMDIFrameWnd*)AfxGetMainWnd();
      CMDIChildWnd* pchild = pframe->MDIGetActive();
      CPSheetDoc* doc = (CPSheetDoc*)pchild->GetActiveDocument();
      doc->m_LastActivePage = GetPageIndex(GetActivePage()); // or GetActiveIndex()
   }

   return CPropertySheet::OnCommand(wParam, lParam);
}

`CPropertySheet::GetPage`

このプロパティシート内の指定したページへのポインターを返します。

CPropertyPage* GetPage(int nPage) const;

パラメーター

nPage
0 から始まる目的のページのインデックス。プロパティシート内のページ数より 0 から 1 未満である必要があります (含む)。

戻り値

nPage パラメーターに対応するページへのポインター。

例

CPropertyPage::OnWizardFinish の例を参照してください。

`CPropertySheet::GetPageCount`

プロパティシート内の現在のページ数を決定します。

int GetPageCount() const;

戻り値

プロパティシート内のページ数。

例

CPropertyPage::OnWizardFinish の例を参照してください。

`CPropertySheet::GetPageIndex`

プロパティシート内の指定したページのインデックス番号を取得します。

int GetPageIndex(CPropertyPage* pPage);

パラメーター

pPage
インデックスが見つかったページをポイントします。 NULL にすることはできません。

戻り値

ページのインデックス番号。

解説

たとえば、SetActivePageまたはGetPageを使用するために、GetPageIndexを使用してページインデックスを取得します。

例

CPropertySheet::GetActivePage の例を参照してください。

`CPropertySheet::GetTabControl`

タブコントロールに固有の操作 (つまり、 CTabCtrlの API のいずれかを使用する) を行うタブコントロールへのポインターを取得します。

CTabCtrl* GetTabControl() const;

戻り値

タブコントロールへのポインター。

解説

たとえば、初期化中に各タブにビットマップを追加する場合は、このメンバー関数を呼び出します。

例

// Create and associate a tooltip control to the tab control of 
// CMyTTPropertySheet.  CMyTTPropertySheet is a CPropertySheet-derived
// class.
BOOL CMyTTPropertySheet::OnInitDialog()
{
   BOOL bResult = CPropertySheet::OnInitDialog();

   // Create a tooltip control.  m_pToolTipCtrl is a member variable
   // of type CToolTipCtrl* in CMyTTPropertySheet class.  It is 
   // initialized to NULL in the constructor, and destroyed in the 
   // destructor of CMyTTPropertySheet class.
   m_pToolTipCtrl = new CToolTipCtrl;
   if (!m_pToolTipCtrl->Create(this))
   {
      TRACE(_T("Unable To create ToolTip\n"));
      return bResult;
   }

   // Associate the tooltip control to the tab control
   // of CMyPropertySheet.
   CTabCtrl* ptab = GetTabControl();
   ptab->SetToolTips(m_pToolTipCtrl);

   // Get the bounding rectangle of each tab in the tab control of the
   // property sheet. Use this rectangle when registering a tool with 
   // the tool tip control.  IDS_FIRST_TOOLTIP is the first ID string 
   // resource that contains the text for the tool.
   int count = ptab->GetItemCount();
   int id = IDS_FIRST_TOOLTIP;
   for (int i = 0; i < count; i++)
   {
      CRect r;
      ptab->GetItemRect(i, &r);
      VERIFY(m_pToolTipCtrl->AddTool(ptab, id, &r, id));
      id++;
   }

   // Activate the tooltip control.
   m_pToolTipCtrl->Activate(TRUE);

   return bResult;
}

// Override PreTranslateMessage() so RelayEvent() can be 
// called to pass a mouse message to CMyTTPropertySheet's 
// tooltip control for processing.
BOOL CMyTTPropertySheet::PreTranslateMessage(MSG* pMsg)
{
   if (NULL != m_pToolTipCtrl)
      m_pToolTipCtrl->RelayEvent(pMsg);

   return CPropertySheet::PreTranslateMessage(pMsg);
}

`CPropertySheet::m_psh`

メンバーが PROPSHEETHEADERの特性を格納する構造体。

解説

この構造体を使用して、プロパティシートが構築された後、 DoModal メンバー関数で表示される前にプロパティシートの外観を初期化します。たとえば、m_pshのdwSize メンバーを、プロパティシートのサイズに設定します。

メンバーの一覧など、この構造の詳細については、Windows SDK の PROPSHEETHEADER を参照してください。

例

// This code fragment shows how to change CPropertySheet's settings 
// before it is shown.  After the changes, CPropertySheet has the 
// caption "Simple Properties", no "Apply" button, and the 
// second page (CColorPage) initially on top.  

CPropertySheet dlgPropertySheet(_T("Simple PropertySheet"));

CStylePage stylePage;
CColorPage colorPage;
CShapePage shapePage;
dlgPropertySheet.AddPage(&stylePage);
dlgPropertySheet.AddPage(&colorPage);
dlgPropertySheet.AddPage(&shapePage);

dlgPropertySheet.m_psh.dwFlags |= PSH_NOAPPLYNOW | PSH_PROPTITLE;
dlgPropertySheet.m_psh.pszCaption = _T("Simple");
dlgPropertySheet.m_psh.nStartPage = 1;

dlgPropertySheet.DoModal();

`CPropertySheet::MapDialogRect`

四角形のダイアログボックスの単位を画面の単位に変換します。

void MapDialogRect(LPRECT lpRect) const;

パラメーター

lpRect
変換するダイアログボックス座標を含む RECT 構造体または CRect オブジェクトを指します。

解説

ダイアログボックスの単位は、ダイアログボックステキストに使用されるフォント内の文字の平均幅と高さから派生した現在のダイアログボックスの基本単位に関して記述されます。 1 つの水平単位はダイアログボックスの基本幅単位の 4 分の 1、垂直単位はダイアログボックスの基本高さの単位の 8 分の 1 です。

GetDialogBaseUnits Windows 関数はシステムフォントのサイズ情報を返しますが、リソース定義ファイルで DS_SETFONT スタイルを使用する場合は、プロパティシートごとに異なるフォントを指定できます。 Windows SDK で説明されている MapDialogRect Windows 関数は、このダイアログボックスに適したフォントを使用します。

MapDialogRectメンバー関数は、lpRectのダイアログボックスの単位を画面単位 (ピクセル) に置き換え、四角形を使用してダイアログボックスを作成したり、ボックス内にコントロールを配置したりできるようにします。

`CPropertySheet::OnInitDialog`

プロパティシートの初期化を拡張するためにオーバーライドします。

virtual BOOL OnInitDialog();

戻り値

アプリケーションがプロパティシートのコントロールのいずれかに入力フォーカスを設定するかどうかを指定します。 OnInitDialog 0 以外の値が返された場合、Windows は入力フォーカスをプロパティシートの最初のコントロールに設定します。アプリケーションは、プロパティシートのコントロールのいずれかに入力フォーカスを明示的に設定した場合にのみ、0 を返すことができます。

解説

このメンバー関数は、 WM_INITDIALOG メッセージに応答して呼び出されます。このメッセージは、プロパティシートが表示される直前に発生する、 Create または DoModal の呼び出し中にプロパティシートに送信されます。

プロパティシートの初期化時に特別な処理を実行する必要がある場合は、このメンバー関数をオーバーライドします。オーバーライドされたバージョンでは、最初に基底クラス OnInitDialog を呼び出しますが、戻り値は無視します。通常は、オーバーライドされたメンバー関数から TRUE を返します。

このメンバー関数のメッセージマップエントリは必要ありません。

`CPropertySheet::PressButton`

プロパティシート内の指定したボタンの選択をシミュレートします。

void PressButton(int nButton);

パラメーター

nButton
nButton : 押すボタンを識別します。このパラメーターには、次の値のいずれかを指定できます。

PSBTN_BACK [戻る] ボタンを選択します。
PSBTN_NEXT [次へ] ボタンを選択します。
PSBTN_FINISH [完了] ボタンを選択します。
PSBTN_OK [OK] ボタンを選択します。
PSBTN_APPLYNOW [今すぐ適用] ボタンを選択します。
PSBTN_CANCEL [キャンセル] ボタンを選択します。
PSBTN_HELP [ヘルプ] ボタンを選択します。

解説

Windows SDK の Pressbutton メッセージの詳細については、 PSM_PRESSBUTTON を参照してください。

PressButtonの呼び出しは、プロパティページからフレームワークにPSN_APPLY通知を送信しません。この通知を送信するには、 CPropertyPage::OnOKを呼び出します。

例

// Simulate the selection of OK and Cancel buttons when Alt+K and
// Alt+C are pressed.  CMyPropertySheet is a CPropertySheet-derived 
// class.
BOOL CMyPropertySheet::PreTranslateMessage(MSG* pMsg)
{
   if (pMsg->message >= WM_KEYFIRST && pMsg->message <= WM_KEYLAST)
   {
      BOOL altkey = GetKeyState(VK_MENU) < 0;
      if (altkey)
      {
         BOOL handled = TRUE;
         switch (toupper((int)pMsg->wParam))
         {
         case 'C':                     // for Alt+C - Cancel button
            PressButton(PSBTN_CANCEL);   // or EndDialog(IDCANCEL);
            break;

         case 'K':                     // for Alt+K - OK button
            PressButton(PSBTN_OK);      // or EndDialog(IDOK);
            break;

         default:
            handled = FALSE;
         }

         if (handled)
            return TRUE;
      }
   }

   return CPropertySheet::PreTranslateMessage(pMsg);
}

`CPropertySheet::RemovePage`

プロパティシートからページを削除し、関連付けられているウィンドウを破棄します。

void RemovePage(CPropertyPage* pPage);
void RemovePage(int nPage);

パラメーター

pPage
プロパティシートから削除するページをポイントします。 NULL にすることはできません。

nPage
削除するページのインデックス。プロパティシート内のページ数より 0 から 1 未満である必要があります (含む)。

解説

CPropertyPage オブジェクト自体は、CPropertySheet ウィンドウの所有者が閉じられるまで破棄されません。

`CPropertySheet::SetActivePage`

アクティブなページを変更します。

BOOL SetActivePage(int nPage);
BOOL SetActivePage(CPropertyPage* pPage);

パラメーター

nPage
設定するページのインデックス。プロパティシート内のページ数より 0 から 1 ページ未満である必要があります (両端を含む)。

pPage
プロパティシートで設定するページをポイントします。 NULL にすることはできません。

戻り値

プロパティシートが正常にアクティブ化された場合は 0 以外。それ以外の場合は 0。

解説

たとえば、あるページでユーザーの操作によって別のページがアクティブページになる場合は、 SetActivePage を使用します。

例

CPropertySheet::GetActivePage の例を参照してください。

`CPropertySheet::SetFinishText`

[完了] コマンドボタンのテキストを設定します。

void SetFinishText(LPCTSTR lpszText);

パラメーター

lpszText
[完了] コマンドボタンに表示するテキストをポイントします。

解説

SetFinishText呼び出して[完了]コマンドボタンにテキストを表示し、ユーザーがウィザードの最後のページでアクションを完了した後で[次へ]ボタンと[戻る]ボタンを非表示にします。

例

// CShapePage is the last wizard property page. Enable the Back 
// button and change the Next button to Finish. The "Finish" button 
// will have "Done" as its caption.
BOOL CShapePage::OnSetActive()
{
   CPropertySheet* psheet = (CPropertySheet*)GetParent();
   psheet->SetWizardButtons(PSWIZB_BACK | PSWIZB_FINISH);
   psheet->SetFinishText(_T("Done"));

   return CPropertyPage::OnSetActive();
}

`CPropertySheet::SetTitle`

プロパティシートのキャプション (フレームウィンドウのタイトルバーに表示されるテキスト) を指定します。

void SetTitle(
    LPCTSTR lpszText,
    UINT nStyle = 0);

パラメーター

nStyle
プロパティシートのタイトルのスタイルを指定します。スタイルは、0 または PSH_PROPTITLEとして指定する必要があります。スタイルが PSH_PROPTITLEとして設定されている場合は、キャプションとして指定されたテキストの後に "Properties" という単語が表示されます。たとえば、 SetTitle("Simple", PSH_PROPTITLE) を呼び出すと、プロパティシートのキャプションが "Simple Properties" になります。

lpszText
プロパティシートのタイトルバーのキャプションとして使用するテキストをポイントします。

解説

既定では、プロパティシートはプロパティシートコンストラクターの caption パラメーターを使用します。

例

// Declare a CPropertySheet object with a caption "Simple PropertySheet".
CPropertySheet dlgPropertySheet(_T("Simple PropertySheet"));

// Add three pages to the CPropertySheet object. CStylePage, CColorPage,
// and CShapePage are CPropertyPage-derived classes created
// by the Add Class wizard.
CStylePage     stylePage;
CColorPage     colorPage;
CShapePage     shapePage;
dlgPropertySheet.AddPage(&stylePage);
dlgPropertySheet.AddPage(&colorPage);
dlgPropertySheet.AddPage(&shapePage);

// Change the caption of the CPropertySheet object 
// from "Simple PropertySheet" to "Simple Properties".
dlgPropertySheet.SetTitle(_T("Simple"), PSH_PROPTITLE);

// Show the CPropertySheet object as MODAL.
dlgPropertySheet.DoModal();

`CPropertySheet::SetWizardButtons`

ウィザードのプロパティシートの [戻る]、[次へ]、または [完了] ボタンを有効または無効にします。

void SetWizardButtons(DWORD dwFlags);

パラメーター

dwFlags
ウィザードボタンの機能と外観をカスタマイズするフラグのセット。このパラメーターは、次の値と組み合わせて指定できます。

PSWIZB_BACK [戻る] ボタン
PSWIZB_NEXT [次へ] ボタン
PSWIZB_FINISH [完了] ボタン
PSWIZB_DISABLEDFINISH [完了を無効にする] ボタン

解説

ダイアログが開いた後にのみSetWizardButtonsを呼び出します。DoModalを呼び出す前にSetWizardButtonsを呼び出すことはできません。通常、CPropertyPage::OnSetActiveからSetWizardButtonsを呼び出す必要があります。

ユーザーがウィザードを完了したら、[完了] ボタンのテキストを変更するか、[次へ] ボタンと [戻る] ボタンを非表示にする場合は、 SetFinishTextを呼び出します。 [完了] と [次へ] で同じボタンが共有されることに注意してください。 [完了] または [次へ] ボタンは一度に表示できますが、両方を表示することはできません。

例

CPropertySheetには、CStylePage、CColorPage、CShapePageの 3 つのウィザードプロパティページがあります。次のコードフラグメントは、ウィザードのプロパティページで Back と Next ボタンを有効または無効にする方法を示しています。

// CStylePage is the first wizard property page.  Disable the Back 
// button but enable the Next button.
BOOL CStylePage::OnSetActive() 
{
   CPropertySheet* psheet = (CPropertySheet*) GetParent();   
   psheet->SetWizardButtons(PSWIZB_NEXT);
   
   return CPropertyPage::OnSetActive();
}

// CColorPage is the second wizard property page. Enable both the 
// Back button and the Next button.
BOOL CColorPage::OnSetActive()
{
   CPropertySheet* psheet = (CPropertySheet*)GetParent();
   psheet->SetWizardButtons(PSWIZB_BACK | PSWIZB_NEXT);

   return CPropertyPage::OnSetActive();
}

// CShapePage is the last wizard property page. Enable the Back 
// button and change the Next button to Finish. The "Finish" button 
// will have "Done" as its caption.
BOOL CShapePage::OnSetActive()
{
   CPropertySheet* psheet = (CPropertySheet*)GetParent();
   psheet->SetWizardButtons(PSWIZB_BACK | PSWIZB_FINISH);
   psheet->SetFinishText(_T("Done"));

   return CPropertyPage::OnSetActive();
}

`CPropertySheet::SetWizardMode`

ウィザードとしてプロパティページを確立します。

void SetWizardMode();

解説

ウィザードのプロパティページの主な特徴は、ユーザーがタブではなく[次へ]、[完了]、[戻る]、および [キャンセル] ボタンを使用して移動することです。

DoModalを呼び出す前にSetWizardModeを呼び出します。 SetWizardModeを呼び出すと、DoModalはID_WIZFINISH (ユーザーが [完了] ボタンで閉じた場合) またはIDCANCELを返します。

SetWizardMode は、 PSH_WIZARD フラグを設定します。

例

CPropertySheet sheet(_T("Simple PropertySheet"));

CStylePage pageStyle;
CColorPage pageColor;
CShapePage pageShape;

sheet.AddPage(&pageStyle);
sheet.AddPage(&pageColor);
sheet.AddPage(&pageShape);

sheet.SetWizardMode();

sheet.DoModal();

次の方法で共有

CPropertySheet クラス

構文

メンバー

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

パブリック メソッド

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

解説

継承階層

要件

CPropertySheet::AddPage

パラメーター

解説

例

CPropertySheet::Construct

パラメーター

解説

例

CPropertySheet::CPropertySheet

パラメーター

解説

例

CPropertySheet::Create

パラメーター

戻り値

解説

例

CPropertySheet::DoModal

戻り値

解説

例

CPropertySheet::EnableStackedTabs

パラメーター

解説

例

CPropertySheet::EndDialog

パラメーター

解説

例

CPropertySheet::GetActiveIndex

戻り値

例

CPropertySheet::GetActivePage

戻り値

解説

例

CPropertySheet::GetPage

パラメーター

戻り値

例

CPropertySheet::GetPageCount

戻り値

例

CPropertySheet::GetPageIndex

パラメーター

戻り値

解説

例

CPropertySheet::GetTabControl

戻り値

解説

例

CPropertySheet::m_psh

解説

例

CPropertySheet::MapDialogRect

パラメーター

解説

CPropertySheet::OnInitDialog

戻り値

解説

CPropertySheet::PressButton

パラメーター

解説

例

CPropertySheet::RemovePage

パラメーター

解説

CPropertySheet::SetActivePage

パラメーター

`CPropertySheet` クラス

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

パブリックメソッド

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

`CPropertySheet::AddPage`

`CPropertySheet::Construct`

`CPropertySheet::CPropertySheet`

`CPropertySheet::Create`

`CPropertySheet::DoModal`

`CPropertySheet::EnableStackedTabs`

`CPropertySheet::EndDialog`

`CPropertySheet::GetActiveIndex`

`CPropertySheet::GetActivePage`

`CPropertySheet::GetPage`

`CPropertySheet::GetPageCount`

`CPropertySheet::GetPageIndex`

`CPropertySheet::GetTabControl`

`CPropertySheet::m_psh`

`CPropertySheet::MapDialogRect`

`CPropertySheet::OnInitDialog`

`CPropertySheet::PressButton`

`CPropertySheet::RemovePage`

`CPropertySheet::SetActivePage`

`CPropertySheet::SetFinishText`

`CPropertySheet::SetTitle`

`CPropertySheet::SetWizardButtons`

`CPropertySheet::SetWizardMode`