IPropertyPage interface
Provides the main features of a property page object that manages a particular page within a property sheet. A property page implements at least IPropertyPage and can optionally implement IPropertyPage2 if selection of a specific property is supported. See IPerPropertyBrowsing::MapPropertyToPage for more information on specific property browsing. The methods of IPropertyPage2 enable the property sheet or property frame to instruct the page when to perform specific actions, mostly based on user input such as switching between pages or pressing various buttons that the frame itself manages in the dialog box.
A property page manages a dialog box that contains only those controls that should be displayed for that one page within the property sheet itself. This means that the dialog box template used to define the page should only carry the WS_CHILD style and no others. It should not include any style related to a frame, caption, or system menus or controls.
When to implement
Implement this interface on a property page object.
When to use
Use this interface to manage a property page object. Typically, this method is called within the OLE-supplied property frame created through OleCreatePropertyFrame or OleCreatePropertyFrameIndirect. Using the methods in this interface, the frame can display the properties and process end-user changes to the property values.
Members
The IPropertyPage interface inherits from the IUnknown interface. IPropertyPage also has these types of members:
Methods
The IPropertyPage interface has these methods.
| Method | Description |
|---|---|
| Activate |
Creates the dialog box window for the property page. |
| Apply |
Applies the current values to the underlying objects associated with the property page as previously passed to IPropertyPage::SetObjects. |
| Deactivate |
Destroys the window created in IPropertyPage::Activate. |
| GetPageInfo |
Retrieves information about the property page. |
| Help |
Invokes the property page help in response to an end-user request. |
| IsPageDirty |
Indicates whether the property page has changed since it was activated or since the most recent call to IPropertyPage::Apply. |
| Move |
Positions and resizes the property page dialog box within the frame. |
| SetObjects |
Provides the property page with an array of pointers to objects associated with this property page. |
| SetPageSite |
Initializes a property page and provides the page with a pointer to the IPropertyPageSite interface through which the property page communicates with the property frame. |
| Show |
Makes the property page dialog box visible or invisible. |
| TranslateAccelerator |
Passes a keystroke to the property page for processing. |
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
IDL |
|
|
IID |
IID_IPropertyPage is defined as B196B28D-BAB4-101A-B69C-00AA00341D07 |
See also
- IPerPropertyBrowsing
- IPropertyPage2
- IPropertyPageSite
- ISpecifyPropertyPage
- OleCreatePropertyFrame
- OleCreatePropertyFrameIndirect