IPropertyPageImpl Class

 

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

This class implements IUnknown and provides a default implementation of the IPropertyPage interface.

System_CAPS_ICON_important.jpg Important

This class and its members cannot be used in applications that execute in the Windows Runtime.

template<class T>  
class IPropertyPageImpl

Parameters

T
Your class, derived from IPropertyPageImpl.

Public Constructors

NameDescription
IPropertyPageImpl::IPropertyPageImplConstructor.

Public Methods

NameDescription
IPropertyPageImpl::ActivateCreates the dialog box window for the property page.
IPropertyPageImpl::ApplyApplies current property page values to the underlying objects specified through SetObjects. The ATL implementation returns S_OK.
IPropertyPageImpl::DeactivateDestroys the window created with Activate.
IPropertyPageImpl::GetPageInfoRetrieves information about the property page.
IPropertyPageImpl::HelpInvokes Windows help for the property page.
IPropertyPageImpl::IsPageDirtyIndicates whether the property page has changed since it was activated.
IPropertyPageImpl::MovePositions and resizes the property page dialog box.
IPropertyPageImpl::SetDirtyFlags the property page's state as changed or unchanged.
IPropertyPageImpl::SetObjectsProvides 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::SetPageSiteProvides the property page with an IPropertyPageSite pointer, through which the property page communicates with the property frame.
IPropertyPageImpl::ShowMakes the property page dialog box visible or invisible.
IPropertyPageImpl::TranslateAcceleratorProcesses a specified keystroke.

Public Data Members

NameDescription
IPropertyPageImpl::m_bDirtySpecifies whether the property page's state has changed.
IPropertyPageImpl::m_dwDocStringStores the resource identifier associated with the text string describing the property page.
IPropertyPageImpl::m_dwHelpContextStores the context identifier for the help topic associated with the property page.
IPropertyPageImpl::m_dwHelpFileStores the resource identifier associated with the name of the help file describing the property page.
IPropertyPageImpl::m_dwTitleStores the resource identifier associated with the text string that appears in the tab for the property page.
IPropertyPageImpl::m_nObjectsStores the number of objects associated with the property page.
IPropertyPageImpl::m_pPageSitePoints to the IPropertyPageSite interface through which the property page communicates with the property frame.
IPropertyPageImpl::m_ppUnkPoints to an array of IUnknown pointers to the objects associated with the property page.
IPropertyPageImpl::m_sizeStores the height and width of the property page's dialog box, in pixels.

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

IPropertyPage

IPropertyPageImpl

Header: atlctl.h

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.

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.

Destroys the dialog box window created with Activate.

HRESULT Deactivate();

Remarks

See IPropertyPage::Deactivate in the Windows SDK.

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.

Invokes Windows help for the property page.

HRESULT Help(PROPPAGEINFO* pPageInfo);

Remarks

See IPropertyPage::Help in the Windows SDK.

The constructor.

IPropertyPageImpl();

Remarks

Initializes all data members.

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.

Specifies whether the property page's state has changed.

BOOL m_bDirty;

Stores the number of objects associated with the property page.

ULONG m_nObjects;

Stores the context identifier for the help topic associated with the property page.

DWORD m_dwHelpContext;

Stores the resource identifier associated with the text string describing the property page.

UINT m_dwDocString;

Stores the resource identifier associated with the name of the help file describing the property page.

UINT m_dwHelpFile;

Stores the resource identifier associated with the text string that appears in the tab for the property page.

UINT m_dwTitle;

Points to the IPropertyPageSite interface through which the property page communicates with the property frame.

IPropertyPageSite* m_pPageSite;

Points to an array of IUnknown pointers to the objects associated with the property page.

IUnknown** m_ppUnk;

Stores the height and width of the property page's dialog box, in pixels.

SIZE m_size;

Positions and resizes the property page dialog box.

HRESULT Move(LPCRECT pRect);

Remarks

See IPropertyPage::Move in the Windows SDK.

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.

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.

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.

Makes the property page dialog box visible or invisible.

HRESULT Show(UINT nCmdShow);

Remarks

See IPropertyPage::Show in the Windows SDK.

Processes the keystroke specified in pMsg.

HRESULT TranslateAccelerator(MSG* pMsg);

Remarks

See IPropertyPage::TranslateAccelerator in the Windows SDK.

IPropertyPage2Impl Class
IPerPropertyBrowsingImpl Class
ISpecifyPropertyPagesImpl Class
Class Overview

Show: