CMFCPropertySheet Class

Article
01/08/2013

The CMFCPropertySheet class supports a property sheet where each property page is denoted by a page tab, a toolbar button, a tree control node, or a list item.

class CMFCPropertySheet : public CPropertySheet

Members

Public Constructors

Name	Description
CMFCPropertySheet::CMFCPropertySheet	Constructs a CMFCPropertySheet object.
CMFCPropertySheet::~CMFCPropertySheet	Destructor.

Public Methods

Name	Description
CMFCPropertySheet::AddPage	Adds a page to the property sheet.
CMFCPropertySheet::AddPageToTree	Adds a new property page to the tree control.
CMFCPropertySheet::AddTreeCategory	Adds a new node to the tree control.
CMFCPropertySheet::EnablePageHeader	Reserves space at the top of each page to draw a custom header.
CMFCPropertySheet::GetHeaderHeight	Retrieves the height of the current header.
CMFCPropertySheet::GetLook	Retrieves an enumeration value that specifies the appearance of the current property sheet.
CMFCPropertySheet::GetTab	Retrieves the internal tab control object that supports the current property sheet control.
CMFCPropertySheet::GetThisClass	Used by the framework to obtain a pointer to the CRuntimeClass object that is associated with this class type.
CMFCPropertySheet::InitNavigationControl	Initializes the appearance of the current property sheet control.
CMFCPropertySheet::OnActivatePage	Called by the framework when a property page is enabled.
CMFCPropertySheet::OnDrawPageHeader	Called by the framework to draw a custom property page header.
CMFCPropertySheet::OnInitDialog	Handles the WM_INITDIALOG message. (Overrides CPropertySheet::OnInitDialog.)
CMFCPropertySheet::OnRemoveTreePage	Called by the framework to remove a property page from a tree control.
CMFCPropertySheet::PreTranslateMessage	Translates window messages before they are dispatched to the TranslateMessage and DispatchMessage Windows functions. (Overrides CPropertySheet::PreTranslateMessage.)
CMFCPropertySheet::RemoveCategory	Removes a node from the tree control.
CMFCPropertySheet::RemovePage	Removes a property page from the property sheet.
CMFCPropertySheet::SetIconsList	Specifies the list of images that are used in the navigation control of the Outlook pane.
CMFCPropertySheet::SetLook	Specifies the appearance of the property sheet.

Remarks

The CMFCPropertySheet class represents property sheets, also known as tab dialog boxes. The CMFCPropertySheet class can display a property page in a variety of ways.

Perform the following steps to use the CMFCPropertySheet class in your application:

Derive a class from the CMFCPropertySheet class and name the class, for example, CMyPropertySheet.
Construct a CMFCPropertyPage object for each property page.
Call the CMFCPropertySheet::SetLook method in the CMyPropertySheet constructor. A parameter of that method specifies that property pages shall be displayed either as tabs along the top or left of the property sheet; tabs in the style of a Microsoft OneNote property sheet; buttons on a Microsoft Outlook toolbar control; nodes on a tree control; or as a list of items on the left side of the property sheet.
If you create a property sheet in the style of a Microsoft Outlook toolbar, call the CMFCPropertySheet::SetIconsList method to associate an image list together with the property pages.
Call the CMFCPropertySheet::AddPage method for each property page.
Create a CMFCPropertySheet control and call its DoModal method.

Illustrations

The following illustration depicts a property sheet that is in the style of an embedded Microsoft Outlook toolbar. The Outlook toolbar appears on the left side of the property sheet.

CMFCPropertySheet color controls

The following illustration depicts a property sheet that contains a CMFCPropertyGridCtrl Class object. That object is a property sheet in the style of a standard common controls property sheet.

CMFCPropertySheet list and property controls