template< class T >
class IPropertyPageImpl
Parameters
T Your class, derived from IPropertyPageImpl.
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
#include <atlctl.h>
See Also IPropertyPage2Impl, IPerPropertyBrowsingImpl, ISpecifyPropertyPagesImpl, IPropertyPage in the Win32 SDK
Class Methods | |
IPropertyPageImpl | Constructor. |
SetDirty | Flags the property page's state as changed or unchanged. |
IPropertyPage Methods | |
Activate | Creates the dialog box window for the property page. |
Apply | Applies current property page values to the underlying objects specified through SetObjects. The ATL implementation returns S_OK. |
Deactivate | Destroys the window created with Activate. |
GetPageInfo | Retrieves information about the property page. |
Help | Invokes Windows help for the property page. |
IsPageDirty | Indicates whether the property page has changed since it was activated or since the most recent call to Apply. |
Move | Positions and resizes the property page dialog box. |
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. |
SetPageSite | Initializes a property page and provides the page with an IPropertyPageSite pointer. Through this pointer, the property page communicates with the property frame. |
Show | Makes the property page dialog box visible or invisible. |
TranslateAccelerator | Instructs the property page to process a specified keystroke. |
Data Members | |
m_bDirty | Specifies whether the property page's state has changed. |
m_nObjects | Stores the number of objects associated with the property page. |
m_dwHelpContext | Stores the context identifier for the help topic associated with the property page. |
m_dwDocString | Stores the resource identifier associated with the text string describing the property page. |
m_dwHelpFile | Stores the resource identifier associated with the name of the help file describing the property page. |
m_dwTitle | Stores the resource identifier associated with the text string that appears in the tab for the property page. |
m_pPageSite | Points to the IPropertyPageSite interface through which the property page communicates with the property frame. |
m_ppUnk | Points to an array of IUnknown pointers to the objects associated with the property page. |
m_size | Stores the height and width of the property page's dialog box, in pixels. |
HRESULT Activate( HWND hWndParent, LPCRECT pRect, BOOL bModal );
See IPropertyPage::Activate in the Win32 SDK.
Remarks
Creates the dialog box window for the property page. By default, the dialog box is always modeless, regardless of the value of the bModal parameter.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::Deactivate
HRESULT Apply( );
See IPropertyPage::Apply in the Win32 SDK.
Remarks
Returns S_OK.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::SetObjects
HRESULT Deactivate( );
See IPropertyPage::Deactivate in the Win32 SDK.
Remarks
Destroys the dialog box window created with Activate.
IPropertyPageImpl Overview| Class Members
HRESULT GetPageInfo( PROPPAGEINFO* pPageInfo );
See IPropertyPage::GetPageInfo in the Win32 SDK.
Remarks
Fills the pPageInfo structure with information contained in the data members. GetPageInfo loads the string resources associated with m_dwDocString, m_dwHelpFile, and m_dwTitle.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::m_dwHelpContext, IPropertyPageImpl::m_size, PROPPAGEINFO in the Win32 SDK
HRESULT Help( PROPPAGEINFO* pPageInfo );
See IPropertyPage::Help in the Win32 SDK.
Remarks
Invokes Windows help for the property page.
IPropertyPageImpl Overview| Class Members
See Also PROPPAGEINFO in the Win32 SDK
IPropertyPageImpl( );
Remarks
The constructor. Initializes all data members.
IPropertyPageImpl Overview| Class Members
HRESULT Help( PROPPAGEINFO* pPageInfo );
See IPropertyPage::Help in the Win32 SDK.
Remarks
Indicates whether the property page has changed since it was activated.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::SetDirty, IPropertyPageImp::m_bDirty
HRESULT Move( LPCRECT pRect );
See IPropertyPage::Move in the Win32 SDK.
Remarks
Positions and resizes the property page dialog box.
IPropertyPageImpl Overview| Class Members
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
Flags the property page's state as changed or unchanged, depending on the value of bDirty. If necessary, SetDirty informs the frame that the property page has changed.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::IsPageDirty, IPropertyPageImpl::SetPageSite, IPropertyPageImpl::m_bDirty
HRESULT SetObjects( ULONG nObjects, IUnknown** ppUnk );
See IPropertyPage::SetObjects in the Win32 SDK.
Remarks
Provides an array of IUnknown pointers for the objects associated with the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::Apply, IPropertyPageImpl::m_nObjects, IPropertyPageImpl::m_ppUnk
HRESULT SetPageSite( IPropertyPageSite* pPageSite );
See IPropertyPage::SetPageSite in the Win32 SDK.
IPropertyPageImpl Overview| Class Members
Remarks
Provides the property page with an IPropertyPageSite pointer, through which the property page communicates with the property frame.
See Also IPropertyPageImpl::m_pPageSite, IPropertyPageSite in the Win32 SDK
HRESULT Show( UINT nCmdShow );
See IPropertyPage::Show in the Win32 SDK.
Remarks
Makes the property page dialog box visible or invisible.
IPropertyPageImpl Overview| Class Members
HRESULT TranslateAccelerator( MSG* pMsg );
See IPropertyPage::TranslateAccelerator in the Win32 SDK.
Remarks
Processes the keystroke specified in pMsg.
IPropertyPageImpl Overview| Class Members
See Also MSG in the Win32 SDK
BOOL m_bDirty;
Remarks
Specifies whether the property page's state has changed.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::IsPageDirty, IPropertyPageImpl::SetDirty
ULONG m_nObjects;
Remarks
Stores the number of objects associated with the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::SetObjects
DWORD m_dwHelpContext;
Remarks
Stores the context identifier for the help topic associated with the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::GetPageInfo
UINT m_dwDocString;
Remarks
Stores the resource identifier associated with the text string describing the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::GetPageInfo
UINT m_dwHelpFile;
Remarks
Stores the resource identifier associated with the name of the help file describing the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::GetPageInfo
UINT m_dwTitle;
Remarks
Stores the resource identifier associated with the text string that appears in the tab for the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::GetPageInfo
IPropertyPageSite* m_pPageSite;
Remarks
Points to the IPropertyPageSite interface through which the property page communicates with the property frame.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::SetPageSite, IPropertyPageSite in the Win32 SDK
IUnknown** m_ppUnk;
Remarks
Points to an array of IUnknown pointers to the objects associated with the property page.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::SetObjects
SIZE m_size;
Remarks
Stores the height and width of the property page's dialog box, in pixels.
IPropertyPageImpl Overview| Class Members
See Also IPropertyPageImpl::GetPageInfo, SIZE in the Win32 SDK