CMFCPropertySheet クラス

[アーティクル]
08/04/2024

CMFCPropertySheet クラスは、各プロパティページがページタブ、ツールバーボタン、ツリーコントロールのノード、またはリスト項目で示されるプロパティシートをサポートします。

構文

class CMFCPropertySheet : public CPropertySheet

メンバー

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

名前	説明
CMFCPropertySheet::CMFCPropertySheet	`CMFCPropertySheet` オブジェクトを構築します。
`CMFCPropertySheet::~CMFCPropertySheet`	デストラクターです。

パブリックメソッド

名前	説明
CMFCPropertySheet::AddPage	プロパティシートにページを追加します。
CMFCPropertySheet::AddPageToTree	ツリーコントロールに新しいプロパティページを追加します。
CMFCPropertySheet::AddTreeCategory	ツリーコントロールに新しいノードを追加します。
CMFCPropertySheet::EnablePageHeader	カスタムヘッダーを描画する領域を各ページの上部に確保します。
CMFCPropertySheet::GetHeaderHeight	現在のヘッダーの高さを取得します。
CMFCPropertySheet::GetLook	現在のプロパティシートの外観を指定する列挙値を取得します。
CMFCPropertySheet::GetNavBarWidth	ナビゲーションバーの幅をピクセル単位で取得します。
CMFCPropertySheet::GetTab	現在のプロパティシートコントロールをサポートする内部タブコントロールオブジェクトを取得します。
`CMFCPropertySheet::GetThisClass`	このクラス型に関連付けられている CRuntimeClass オブジェクトへのポインターを取得するためにフレームワークによって使用されます。
CMFCPropertySheet::InitNavigationControl	現在のプロパティシートコントロールの外観を初期化します。
CMFCPropertySheet::OnActivatePage	プロパティページが有効になったときにフレームワークによって呼び出されます。
CMFCPropertySheet::OnDrawPageHeader	カスタムプロパティページのヘッダーを描画するためにフレームワークによって呼び出されます。
`CMFCPropertySheet::OnInitDialog`	WM_INITDIALOG メッセージを処理します。 ( をオーバーライドしますCPropertySheet::OnInitDialog.)
CMFCPropertySheet::OnRemoveTreePage	ツリーコントロールからプロパティページを削除するためにフレームワークによって呼び出されます。
`CMFCPropertySheet::PreTranslateMessage`	ウィンドウメッセージを TranslateMessage および DispatchMessage Windows 関数にディスパッチする前に変換します。 ( `CPropertySheet::PreTranslateMessage`をオーバーライドします)。
CMFCPropertySheet::RemoveCategory	ツリーコントロールからノードを削除します。
CMFCPropertySheet::RemovePage	プロパティシートからプロパティページを削除します。
CMFCPropertySheet::SetIconsList	Outlook ウィンドウのナビゲーションコントロールで使用されるイメージの一覧を指定します。
CMFCPropertySheet::SetLook	プロパティシートの外観を指定します。

解説

CMFCPropertySheet クラスは、プロパティシート (タブダイアログボックスとも呼ばれます) を表します。 CMFCPropertySheet クラスは、さまざまな方法でプロパティページを表示できます。

アプリケーションで CMFCPropertySheet クラスを使用するには、次の手順を実行します。

CMFCPropertySheet クラスから派生クラスを作成し、名前 (CMyPropertySheet など) を付けます。
プロパティページごとに CMFCPropertyPage オブジェクトを作成します。
CMyPropertySheet コンストラクターで CMFCPropertySheet::SetLook メソッドを呼び出します。このメソッドのパラメーターで、プロパティページの表示方法として、プロパティシートの上部または左側のタブ、Microsoft OneNote プロパティシートスタイルのタブ、Microsoft Outlook ツールバーコントロールのボタン、ツリーコントロールのノード、プロパティシートの左側の項目リストのいずれかを指定します。
Microsoft Outlook ツールバーのスタイルでプロパティシートを作成する場合は、 CMFCPropertySheet::SetIconsList メソッドを呼び出して、イメージリストをプロパティページと関連付けます。
プロパティページごとに CMFCPropertySheet::AddPage メソッドを呼び出します。
CMFCPropertySheet コントロールを作成し、その DoModal メソッドを呼び出します。

図

次の図は、埋め込みの Microsoft Outlook ツールバースタイルのプロパティシートを示しています。プロパティシートの左側に Outlook ツールバーが表示されます。

CMFCPropertySheet カラーコントロール。

次の図は、 CMFCPropertyGridCtrl クラスオブジェクトを含むプロパティシートを示しています。このオブジェクトは、標準のコモンコントロールスタイルのプロパティシートです。

CMFCPropertySheet リストおよびプロパティコントロール。

次の図は、ツリーコントロールスタイルのプロパティシートを示しています。

プロパティツリー。

継承階層

要件

Header: afxpropertysheet.h

CMFCPropertySheet::AddPage

プロパティシートにページを追加します。

void AddPage(CPropertyPage* pPage);

パラメーター

pPage
[in]ページオブジェクトへのポインター。このパラメーターは NULL にはできません。

解説

このメソッドは、指定したプロパティページをプロパティシートの右端のタブとして追加します。そのため、このメソッドを使用して、ページを左から右の順序で追加します。

プロパティシートが Microsoft Outlook のスタイルの場合、フレームワークはプロパティシートの左側にナビゲーションボタンの一覧を表示します。このメソッドは、プロパティページを追加した後、対応するボタンをリストに追加します。プロパティページを表示するには、対応するボタンをクリックします。プロパティシートのスタイルの詳細については、「 CMFCPropertySheet::SetLookを参照してください。

CMFCPropertySheet::AddPageToTree

ツリーコントロールに新しいプロパティページを追加します。

void AddPageToTree(
    CMFCPropertySheetCategoryInfo* pCategory,
    CMFCPropertyPage* pPage,
    int nIconNum=-1,
    int nSelIconNum=-1);

パラメーター

pCategory
[in]親ツリーノードへのポインター。指定したページを最上位ノードに関連付ける場合は NULL。このポインターを取得するには、 CMFCPropertySheet::AddTreeCategory メソッドを呼び出します。

pPage
[in]プロパティページオブジェクトへのポインター。

nIconNum
[in]アイコンの 0 から始まるインデックス。アイコンが使用されていない場合は -1。このアイコンは、ページが選択されていない場合にツリーコントロールのプロパティページの横に表示されます。既定値は -1 です。

nSelIconNum
[in]アイコンの 0 から始まるインデックス。アイコンが使用されていない場合は -1。ページが選択されると、ツリーコントロールのプロパティページの横にアイコンが表示されます。既定値は -1 です。

解説

このメソッドは、ツリーコントロールのリーフとしてプロパティページを追加します。プロパティページを追加するには、CMFCPropertySheet オブジェクトを作成し、look パラメーターをCMFCPropertySheet::PropSheetLook_Treeに設定して CMFCPropertySheet::SetLook メソッドを呼び出し、このメソッドを使用してプロパティページを追加します。

CMFCPropertySheet::AddTreeCategory

ツリーコントロールに新しいノードを追加します。

CMFCPropertySheetCategoryInfo* AddTreeCategory(
    LPCTSTR lpszLabel,
    int nIconNum=-1,
    int nSelectedIconNum=-1,
    const CMFCPropertySheetCategoryInfo* pParentCategory=NULL);

パラメーター

lpszLabel
[in]ノードの名前。

nSelectedIconNum
[in]アイコンの 0 から始まるインデックス。アイコンが使用されていない場合は -1。ページが選択されると、ツリーコントロールのプロパティページの横にアイコンが表示されます。既定値は -1 です。

pParentCategory
[in]親ツリーノードへのポインター。指定したページを最上位ノードに関連付ける場合は NULL。このパラメーターは、 CMFCPropertySheet::AddTreeCategory メソッドで設定します。

戻り値

ツリーコントロール内の新しいノードへのポインター。

解説

このメソッドを使用して、新しいノード (カテゴリとも呼ばれます) をツリーコントロールに追加します。ノードを追加するには、CMFCPropertySheet オブジェクトを作成し、look パラメーターを CMFCPropertySheet::PropSheetLook_Tree に設定して CMFCPropertySheet::SetLook メソッドを呼び出し、このメソッドを使用してノードを追加します。

このメソッドの戻り値は、後続の CMFCPropertySheet::AddPageToTree および CMFCPropertySheet::AddTreeCategory の呼び出しで使用します。

CMFCPropertySheet::CMFCPropertySheet

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

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

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

パラメーター

pszCaption
[in]プロパティシートのキャプションを含む文字列。 Nll は指定できません。

nIDCaption
[in]プロパティシートのキャプションを含むリソース ID。

pParentWnd
[in]プロパティシートの親ウィンドウへのポインター。親ウィンドウがアプリケーションのメインウィンドウの場合は NULL。既定値は NULL です。

iSelectPage
[in]トッププロパティページの 0 から始まるインデックス。既定値は0です。

解説

詳細については、 CPropertySheet::CPropertySheet コンストラクターのパラメーターを参照してください。

CMFCPropertySheet::EnablePageHeader

カスタムヘッダーを描画する領域を各ページの上部に確保します。

void EnablePageHeader(int nHeaderHeight);

パラメーター

nHeaderHeight
[in]ヘッダーの高さ (ピクセル単位)。

解説

nHeaderHeight パラメーターの値を使用してカスタムヘッダーを描画するには、CMFCPropertySheet::OnDrawPageHeader メソッドをオーバーライドします。

CMFCPropertySheet::GetHeaderHeight

現在のヘッダーの高さを取得します。

int GetHeaderHeight() const;

戻り値

ヘッダーの高さ (ピクセル単位)。

解説

このメソッドを呼び出す前に、 CMFCPropertySheet::EnablePageHeader メソッドを呼び出します。

CMFCPropertySheet::GetLook

現在のプロパティシートの外観を指定する列挙値を取得します。

PropSheetLook GetLook() const;

戻り値

プロパティシートの外観を指定する列挙値の 1 つ。使用可能な値の一覧については、 CMFCPropertySheet::SetLook の「解説」セクションの列挙表を参照してください。

CMFCPropertySheet::GetNavBarWidth

ナビゲーションバーの幅を取得します。

int GetNavBarWidth() const;

戻り値

軸スクロールバーの幅 (ピクセル単位)。

CMFCPropertySheet::GetTab

現在のプロパティシートコントロールをサポートする内部タブコントロールオブジェクトを取得します。

CMFCTabCtrl& GetTab() const;

戻り値

内部タブコントロールオブジェクト。

解説

ツリーコントロール、ナビゲーションボタンの一覧、タブ付きページのセットなど、さまざまなスタイルで表示されるようにプロパティシートを設定できます。

このメソッドを呼び出す前に、 CMFCPropertySheet::SetLook メソッドを呼び出して、プロパティシートコントロールの外観を設定します。次に、 CMFCPropertySheet::InitNavigationControl メソッドを呼び出して、内部タブコントロールオブジェクトを初期化します。このメソッドを使用してタブコントロールオブジェクトを取得し、そのオブジェクトを使用してプロパティシートのタブを操作します。

プロパティシートコントロールが Microsoft OneNote のスタイルで表示されるように設定されていない場合、このメソッドはデバッグモードでアサートします。

CMFCPropertySheet::InitNavigationControl

現在のプロパティシートコントロールの外観を初期化します。

virtual CWnd* InitNavigationControl();

戻り値

プロパティシートコントロールのウィンドウへのポインター。

解説

プロパティシートコントロールは、タブ付きページのセット、ツリーコントロール、ナビゲーションボタンの一覧など、いくつかの異なる形式で表示できます。プロパティシートコントロールの外観を指定するには、 CMFCPropertySheet::SetLook メソッドを使用します。

CMFCPropertySheet::OnActivatePage

プロパティページが有効になったときにフレームワークによって呼び出されます。

virtual void OnActivatePage(CPropertyPage* pPage);

パラメーター

pPage
[in]有効なプロパティページを表すプロパティページオブジェクトへのポインター。

解説

既定では、このメソッドは、有効なプロパティページがビューにスクロールされることを保証します。現在のプロパティシートのスタイルに Microsoft Outlook ウィンドウが含まれている場合、このメソッドは対応する Outlook ボタンをチェック状態に設定します。

CMFCPropertySheet::OnDrawPageHeader

カスタムプロパティページのヘッダーを描画するためにフレームワークによって呼び出されます。

virtual void OnDrawPageHeader(
    CDC* pDC,
    int nPage,
    CRect rectHeader);

パラメーター

pDC
[in]デバイスコンテキストへのポインター。

nPage
[in]0 から始まるプロパティページ番号。

rectHeader
[in]ヘッダーを描画する場所を指定する外接する四角形。

解説

既定では、このメソッドは何も実行しません。このメソッドをオーバーライドする場合は、フレームワークがこのメソッドを呼び出す前に、 CMFCPropertySheet::EnablePageHeader メソッドを呼び出します。

CMFCPropertySheet::OnRemoveTreePage

ツリーコントロールからプロパティページを削除するためにフレームワークによって呼び出されます。

virtual BOOL OnRemoveTreePage(CPropertyPage* pPage);

パラメーター

pPage
[in]削除するプロパティページを表すプロパティページオブジェクトへのポインター。

戻り値

このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。

CMFCPropertySheet::RemoveCategory

ツリーコントロールからノードを削除します。

void RemoveCategory(CMFCPropertySheetCategoryInfo* pCategory);

パラメーター

pCategory
[in]削除するカテゴリ (ノード) へのポインター。

解説

ツリーコントロールから、カテゴリとも呼ばれるノードを削除するには、このメソッドを使用します。ツリーコントロールにノードを追加するには、 CMFCPropertySheet::AddTreeCategory メソッドを使用します。

CMFCPropertySheet::RemovePage

プロパティシートからプロパティページを削除します。

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

パラメーター

pPage
[in]削除するプロパティページを表すプロパティページオブジェクトへのポインター。 Nll は指定できません。

nPage
[in]削除するページの 0 から始まるインデックス。

解説

このメソッドは、指定したプロパティページを削除し、関連付けられているウィンドウを破棄します。 pPage パラメーターが指定するプロパティページオブジェクトは、CMFCPropertySheet ウィンドウが閉じられるまで破棄されません。

CMFCPropertySheet::SetIconsList

Outlook ウィンドウのナビゲーションコントロールで使用されるイメージの一覧を指定します。

BOOL SetIconsList(
    UINT uiImageListResID,
    int cx,
    COLORREF clrTransparent=RGB(255, 0, 255));
void SetIconsList(HIMAGELIST hIcons);

パラメーター

uiImageListResID
[in]イメージリストのリソース ID。

cx
[in]イメージリスト内のアイコンの幅 (ピクセル単位)。

clrTransparent
[in]透明なイメージの色。この色である画像の部分は透明になります。既定値は、色マゼンタ、RGB(255,0,255) です。

hIcons
[in]既存のイメージリストへのハンドル。

戻り値

最初のメソッドオーバーロード構文では、このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。

解説

プロパティシートが Microsoft Outlook のスタイルの場合、フレームワークは、Outlook ウィンドウコントロールと呼ばれるナビゲーションボタンの一覧をプロパティシートの左側に表示します。 Outlook ウィンドウコントロールで使用する画像リストを設定するには、このメソッドを使用します。

このメソッドをサポートするメソッドの詳細については、「 CImageList::Create および CImageList::Add を参照してください。プロパティシートのスタイルを設定する方法の詳細については、「 CMFCPropertySheet::SetLookを参照してください。

CMFCPropertySheet::SetLook

プロパティシートの外観を指定します。

void SetLook(
    PropSheetLook look,
    int nNavControlWidth=100);

パラメーター

ほら
[in]プロパティシートの外観を指定する列挙値の 1 つ。プロパティシートの既定のスタイルは CMFCPropertySheet::PropSheetLook_Tabs。詳細については、このトピックの「解説」セクションの表を参照してください。

nNavControlWidth
[in]ナビゲーションコントロールの幅 (ピクセル単位)。既定値は 100 です。

解説

プロパティシートを既定以外のスタイルで表示するには、プロパティシートウィンドウを作成する前にこのメソッドを呼び出します。

次の表に、 look パラメーターで指定できる列挙値を示します。

値	説明
`CMFCPropertySheet::PropSheetLook_Tabs`	(既定値)各プロパティページのタブを表示します。タブはプロパティシートの上部に表示され、1 行に収まるタブ数よりも多くのタブがある場合は積み重ねられます。
`CMFCPropertySheet::PropSheetLook_OutlookBar`	プロパティシートの左側にある Microsoft Outlook バーのスタイルで、ナビゲーションボタンの一覧を表示します。リスト内の各ボタンは、プロパティページに対応します。リストの表示領域に収まるよりも多くのボタンがある場合、フレームワークはスクロール矢印を表示します。
`CMFCPropertySheet::PropSheetLook_Tree`	プロパティシートの左側にツリーコントロールを表示します。ツリーコントロールの各親ノードまたは子ノードは、プロパティページに対応します。ツリーコントロールの表示領域に収まるノード数を超えるノードがある場合、フレームワークはスクロール矢印を表示します。
`CMFCPropertySheet::PropSheetLook_OneNoteTabs`	各プロパティページのタブを Microsoft OneNote のスタイルで表示します。 1 行に収まるタブが多い場合、フレームワークはプロパティシートの上部にタブを表示し、スクロール矢印を表示します。
`CMFCPropertySheet::PropSheetLook_List`	プロパティシートの左側にリストを表示します。各リストアイテムは、プロパティページに対応します。リストの表示領域に収まるよりも多くのリスト項目がある場合、フレームワークはスクロール矢印を表示します。

次の方法で共有

CMFCPropertySheet クラス

構文

メンバー

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

パブリック メソッド

解説

図

継承階層

要件

CMFCPropertySheet::AddPage

パラメーター

解説

CMFCPropertySheet::AddPageToTree

パラメーター

解説

CMFCPropertySheet::AddTreeCategory

パラメーター

戻り値

解説

CMFCPropertySheet::CMFCPropertySheet

パラメーター

解説

CMFCPropertySheet::EnablePageHeader

パラメーター

解説

CMFCPropertySheet::GetHeaderHeight

戻り値

解説

CMFCPropertySheet::GetLook

戻り値

CMFCPropertySheet::GetNavBarWidth

戻り値

CMFCPropertySheet::GetTab

戻り値

解説

CMFCPropertySheet::InitNavigationControl

戻り値

解説

CMFCPropertySheet::OnActivatePage

パラメーター

解説

CMFCPropertySheet::OnDrawPageHeader

パラメーター

解説

CMFCPropertySheet::OnRemoveTreePage

パラメーター

戻り値

CMFCPropertySheet::RemoveCategory

パラメーター

解説

CMFCPropertySheet::RemovePage

パラメーター

解説

CMFCPropertySheet::SetIconsList

パラメーター

戻り値

解説

CMFCPropertySheet::SetLook

パラメーター

解説

関連項目

フィードバック

その他のリソース

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

パブリックメソッド