IPropertyPageSite interface (ocidl.h)

Article
07/22/2021

Provides the main features for a property page site object.

Inheritance

The IPropertyPageSite interface inherits from the IUnknown interface. IPropertyPageSite also has these types of members:

Methods

The IPropertyPageSite interface has these methods.


IPropertyPageSite::GetLocaleID Retrieves the locale identifier (an LCID) that a property page can use to adjust its locale-specific settings.
IPropertyPageSite::GetPageContainer Retrieves a pointer to the object representing the entire property frame dialog box that contains all the pages. Calling this method could potentially allow one page to navigate to another.
IPropertyPageSite::OnStatusChange Informs the frame that the property page managed by this site has changed its state, that is, one or more property values have been changed in the page. Property pages should call this method whenever changes occur in their dialog boxes.
IPropertyPageSite::TranslateAccelerator Passes a keystroke to the property frame for processing.

Remarks

For each property page created within a property frame, the frame creates a property page site to provide information to the property page and to receive notifications from the page when changes occur. This latter notification is used to initiate a call to IPropertyPage::IsPageDirty, the return value of which is then used to enable or disable the frame's Apply button.

OLE Implementation

The system provides an implementation of the IPropertyPageSite interface through the OleCreatePropertyFrame or OleCreatePropertyFrameIndirect functions. The frame implementation provided through these functions only implements the OnStatusChange and GetLocaleID methods. The GetPageContainer and TranslateAccelerator methods return E_NOTIMPL.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ocidl.h