IPropertyPage Interface

IID_IPropertyPage

{B196B28D-BAB4-101A-B69C-00AA00341D07}

The 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 allow 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.

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.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IPropertyPage Methods

Description

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.

Activate

Creates the dialog box window for the property page.

Deactivate

Destroys the window created with Activate.

GetPageInfo

Returns information about the property page.

SetObjects

Provides the property page with an array of IUnknown pointers for objects associated with this property page.

Show

Makes the property page dialog box visible or invisible.

Move

Positions and resizes the property page dialog box within the frame

IsPageDirty

Indicates whether the property page has changed since activated or since the most recent call to Apply.

Apply

Applies current property page values to underlying objects specified through SetObjects.

Help

Invokes help in response to end-user request.

TranslateAccelerator

Provides a pointer to a MSG structure that specifies a keystroke to process.

SetPageSite

FUNCTION IPropertyPage_SetPageSite ( _

  BYVAL pthis AS DWORD PTR _

, BYVAL pPageSite AS DWORD _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IPropertyPage_SetPageSite (pthis, pPageSite) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Activate

FUNCTION IPropertyPage_Activate ( _

  BYVAL pthis AS DWORD PTR _

, BYVAL hWndParent AS DWORD _

, BYREF pRect AS RECT _

, BYVAL bModal AS LONG _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IPropertyPage_Activate (pthis, hWndParent, pRect, bModal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Deactivate

FUNCTION IPropertyPage_Deactivate ( _

  BYVAL pthis AS DWORD PTR _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IPropertyPage_Deactivate (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetPageInfo

FUNCTION IPropertyPage_GetPageInfo ( _

  BYVAL pthis AS DWORD PTR _

, BYREF pPageInfo AS PROPPAGEINFO _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IPropertyPage_GetPageInfo (pthis, pPageInfo) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetObjects

FUNCTION IPropertyPage_SetObjects ( _

  BYVAL pthis AS DWORD PTR _

, BYVAL cObjects AS DWORD _

, BYVAL ppUnk AS DWORD _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IPropertyPage_SetObjects (pthis, cObjects, ppUnk) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Show

FUNCTION IPropertyPage_Show ( _

  BYVAL pthis AS DWORD PTR _

, BYVAL nCmdShow AS DWORD _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IPropertyPage_Show (pthis, nCmdShow) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Move

FUNCTION IPropertyPage_Move ( _

  BYVAL pthis AS DWORD PTR _

, BYREF pRect AS RECT _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IPropertyPage_Move (pthis, pRect) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

IsPageDirty

FUNCTION IPropertyPage_IsPageDirty ( _

  BYVAL pthis AS DWORD PTR _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IPropertyPage_IsPageDirty (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Apply

FUNCTION IPropertyPage_Apply ( _

  BYVAL pthis AS DWORD PTR _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IPropertyPage_Apply (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Help

FUNCTION IPropertyPage_Help ( _

  BYVAL pthis AS DWORD PTR _

, BYVAL strHelpDir AS STRING _

  ) AS LONG
 

  LOCAL HRESULT AS LONG

  strHelpDir = UCODE$(strHelpDir) & $NUL
  CALL DWORD @@pthis[12] USING IPropertyPage_Help (pthis, strHelpDir) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

TranslateAccelerator

FUNCTION IPropertyPage_TranslateAccelerator ( _

  BYVAL pthis AS DWORD PTR _

, BYREF pMsg AS tagMsg _

  ) AS LONG
 

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IPropertyPage_TranslateAccelerator (pthis, pMsg) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION