Description
This class is used to create and manage a property page A property sheet will
have one or more property pages. These pages are much like dialogs which are
presented within a tabbed dialog or within a wizard. The data on a property page
can be validated before the next page is presented.
Refer to the
PropertySheet demo program for an example of how property pages can be used.
CPropertyPage Members
Construction
| CPropertyPage |
CPropertyPage (UINT nIDTemplate, LPCTSTR szTitle = NULL);
The constructor for
CPropertyPage. |
Attributes and State functions
| GetPSP |
PROPSHEETPAGE GetPSP() const {return m_PSP;}
Retrieves the
PROPSHEETPAGE struct for this property page. |
| IsButtonEnabled |
BOOL IsButtonEnabled(int iButton) const;
Returns TRUE if the
specified button is active. |
| SetModified |
void SetModified(BOOL bChanged) const;
Flags a property page as
modified or unmodified. |
Overridables
| DialogProc |
virtual BOOL DialogProc(UINT uMsg, WPARAM wParam, LPARAM lParam);;
Override this function to handle messages received
by the property page. |
| OnApply |
virtual int OnApply();
Called when the Apply
button is pressed. |
| OnCancel |
virtual void OnCancel();
Called when the Cancel
button is pressed. |
| OnHelp |
virtual void OnHelp();
Called when the Help
button is pressed. |
| OnInitDialog |
virtual BOOL OnInitDialog();
Called when the property
page is created. |
| OnKillActive |
virtual BOOL OnKillActive();
Called when the property
page becomes inactive in response to an OK or Apply button press.
|
| OnNotify |
virtual LRESULT OnNotify(WPARAM wParam, LPARAM lParam);
Called when a notification from a child control is
received. |
| OnOK |
virtual int OnOK();
Called when the OK button
is pressed. |
| OnQueryCancel |
virtual BOOL OnQueryCancel();
Called when the Cancel
button is press, before the cancel has taken place. |
| OnQuerySiblings |
virtual BOOL OnQuerySiblings(WPARAM wParam, LPARAM lParam);
Called in response to a
query from the property sheet. Return zero to indicate passed, or nonzero
to indicated failed. |
| OnSetActive |
virtual int OnSetActive();
Called when the property
page becomes active. |
| OnWizardBack |
virtual int OnWizardBack();
Called when the Back
button is pressed on a wizard. |
| OnWizardFinish |
virtual BOOL OnWizardFinish();
Called when the Finish
button is pressed on a wizard. |
| OnWizardNext |
virtual int OnWizardNext();
Called when the Next
button is pressed on a wizard. |
| PretranslateMessage |
virtual BOOL PreTranslateMessage(MSG* pMsg);
Called allow the tab control to translate keyboard
input before the message is passed on to the message loop. |
Operations
| CancelToClose |
void CancelToClose() const;
Disables the Cancel
button and changes the text of the OK button to "Close." |
| QuerySiblings |
LRESULT QuerySiblings(WPARAM wParam, LPARAM lParam) const;
Used to query other property pages belonging to this
property sheet. |
| SetTitle |
void SetTitle(LPCTSTR szTitle);
Sets the property sheet's title. |
| SetWizardButtons |
void SetWizardButtons(DWORD dwFlags) const;
Sets the wizard buttons. |
Base class Members
For base class members, refer to the members of CWnd.
Summary Information
| Header file |
propertysheet.h |
| Win32/64 support |
Yes |
| WinCE support |
Yes |