IPropertyPageImpl Class
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at IPropertyPageImpl Class.
This class implements IUnknown and provides a default implementation of the IPropertyPage interface.
Important
This class and its members cannot be used in applications that execute in the Windows Runtime.
Syntax
template<class T>
class IPropertyPageImpl
Parameters
T
Your class, derived from IPropertyPageImpl.
Members
Public Constructors
| Name | Description |
|---|---|
| IPropertyPageImpl::IPropertyPageImpl | Constructor. |
Public Methods
| Name | Description |
|---|---|
| IPropertyPageImpl::Activate | Creates the dialog box window for the property page. |
| IPropertyPageImpl::Apply | Applies current property page values to the underlying objects specified through SetObjects. The ATL implementation returns S_OK. |
| IPropertyPageImpl::Deactivate | Destroys the window created with Activate. |
| IPropertyPageImpl::GetPageInfo | Retrieves information about the property page. |
| IPropertyPageImpl::Help | Invokes Windows help for the property page. |
| IPropertyPageImpl::IsPageDirty | Indicates whether the property page has changed since it was activated. |
| IPropertyPageImpl::Move | Positions and resizes the property page dialog box. |
| IPropertyPageImpl::SetDirty | Flags the property page's state as changed or unchanged. |
| IPropertyPageImpl::SetObjects | Provides an array of IUnknown pointers for the objects associated with the property page. These objects receive the current property page values through a call to Apply. |
| IPropertyPageImpl::SetPageSite | Provides the property page with an IPropertyPageSite pointer, through which the property page communicates with the property frame. |
| IPropertyPageImpl::Show | Makes the property page dialog box visible or invisible. |
| IPropertyPageImpl::TranslateAccelerator | Processes a specified keystroke. |
Public Data Members
| Name | Description |
|---|---|
| IPropertyPageImpl::m_bDirty | Specifies whether the property page's state has changed. |
| IPropertyPageImpl::m_dwDocString | Stores the resource identifier associated with the text string describing the property page. |
| IPropertyPageImpl::m_dwHelpContext | Stores the context identifier for the help topic associated with the property page. |
| IPropertyPageImpl::m_dwHelpFile | Stores the resource identifier associated with the name of the help file describing the property page. |
| IPropertyPageImpl::m_dwTitle | Stores the resource identifier associated with the text string that appears in the tab for the property page. |
| IPropertyPageImpl::m_nObjects | Stores the number of objects associated with the property page. |
| IPropertyPageImpl::m_pPageSite | Points to the IPropertyPageSite interface through which the property page communicates with the property frame. |
| IPropertyPageImpl::m_ppUnk | Points to an array of IUnknown pointers to the objects associated with the property page. |
| IPropertyPageImpl::m_size | Stores the height and width of the property page's dialog box, in pixels. |
Remarks
The IPropertyPage interface allows an object to manage a particular property page within a property sheet. Class IPropertyPageImpl provides a default implementation of this interface and implements IUnknown by sending information to the dump device in debug builds.
Related Articles ATL Tutorial, Creating an ATL Project
Inheritance Hierarchy
IPropertyPage
IPropertyPageImpl
Requirements
Header: atlctl.h
IPropertyPageImpl::Activate
Creates the dialog box window for the property page.
HRESULT Activate(
HWND hWndParent,
LPCRECT pRect,
BOOL bModal);
Remarks
By default, the dialog box is always modeless, regardless of the value of the bModal parameter.
See IPropertyPage::Activate in the Windows SDK.
IPropertyPageImpl::Apply
Applies current property page values to the underlying objects specified through SetObjects.
HRESULT Apply();
Return Value
Returns S_OK.
Remarks
See IPropertyPage::Apply in the Windows SDK.
IPropertyPageImpl::Deactivate
Destroys the dialog box window created with Activate.
HRESULT Deactivate();
Remarks
See IPropertyPage::Deactivate in the Windows SDK.
IPropertyPageImpl::GetPageInfo
Fills the pPageInfo structure with information contained in the data members.
HRESULT GetPageInfo(PROPPAGEINFO* pPageInfo);
Remarks
GetPageInfo loads the string resources associated with m_dwDocString, m_dwHelpFile, and m_dwTitle.
See IPropertyPage::GetPageInfo in the Windows SDK.
IPropertyPageImpl::Help
Invokes Windows help for the property page.
HRESULT Help(PROPPAGEINFO* pPageInfo);
Remarks
See IPropertyPage::Help in the Windows SDK.
IPropertyPageImpl::IPropertyPageImpl
The constructor.
IPropertyPageImpl();
Remarks
Initializes all data members.
IPropertyPageImpl::IsPageDirty
Indicates whether the property page has changed since it was activated.
HRESULT IsPageDirty(void);
Remarks
IsPageDirty returns S_OK if the page has changed since it was activated.
IPropertyPageImpl::m_bDirty
Specifies whether the property page's state has changed.
BOOL m_bDirty;
IPropertyPageImpl::m_nObjects
Stores the number of objects associated with the property page.
ULONG m_nObjects;
IPropertyPageImpl::m_dwHelpContext
Stores the context identifier for the help topic associated with the property page.
DWORD m_dwHelpContext;
IPropertyPageImpl::m_dwDocString
Stores the resource identifier associated with the text string describing the property page.
UINT m_dwDocString;
IPropertyPageImpl::m_dwHelpFile
Stores the resource identifier associated with the name of the help file describing the property page.
UINT m_dwHelpFile;
IPropertyPageImpl::m_dwTitle
Stores the resource identifier associated with the text string that appears in the tab for the property page.
UINT m_dwTitle;
IPropertyPageImpl::m_pPageSite
Points to the IPropertyPageSite interface through which the property page communicates with the property frame.
IPropertyPageSite* m_pPageSite;
IPropertyPageImpl::m_ppUnk
Points to an array of IUnknown pointers to the objects associated with the property page.
IUnknown** m_ppUnk;
IPropertyPageImpl::m_size
Stores the height and width of the property page's dialog box, in pixels.
SIZE m_size;
IPropertyPageImpl::Move
Positions and resizes the property page dialog box.
HRESULT Move(LPCRECT pRect);
Remarks
See IPropertyPage::Move in the Windows SDK.
IPropertyPageImpl::SetDirty
Flags the property page's state as changed or unchanged, depending on the value of bDirty.
void SetDirty(BOOL bDirty);
Parameters
bDirty
[in] If TRUE, the property page's state is marked as changed. Otherwise, it is marked as unchanged.
Remarks
If necessary, SetDirty informs the frame that the property page has changed.
IPropertyPageImpl::SetObjects
Provides an array of IUnknown pointers for the objects associated with the property page.
HRESULT SetObjects(ULONG nObjects, IUnknown** ppUnk);
Remarks
See IPropertyPage::SetObjects in the Windows SDK.
IPropertyPageImpl::SetPageSite
Provides the property page with an IPropertyPageSite pointer, through which the property page communicates with the property frame.
HRESULT SetPageSite(IPropertyPageSite* pPageSite);
Remarks
See IPropertyPage::SetPageSite in the Windows SDK.
IPropertyPageImpl::Show
Makes the property page dialog box visible or invisible.
HRESULT Show(UINT nCmdShow);
Remarks
See IPropertyPage::Show in the Windows SDK.
IPropertyPageImpl::TranslateAccelerator
Processes the keystroke specified in pMsg.
HRESULT TranslateAccelerator(MSG* pMsg);
Remarks
See IPropertyPage::TranslateAccelerator in the Windows SDK.
See Also
IPropertyPage2Impl Class
IPerPropertyBrowsingImpl Class
ISpecifyPropertyPagesImpl Class
Class Overview