PROPSHEETPAGE (Compact 2013)

3/28/2014

This structure defines a page in a property sheet.

Syntax

typedef struct _PROPSHEETPAGE { 
  DWORD dwSize; 
  DWORD dwFlags; 
  HINSTANCE hInstance; 
  union {
    LPCSTR pszTemplate; 
    LPCDLGTEMPLATE pResource; 
  };
  union {
    HICON hIcon; 
    LPCSTR pszIcon; 
  };
  LPCSTR pszTitle; 
  DLGPROC pfnDlgProc; 
  LPARAM lParam; 
  LPFNPSPCALLBACK pfnCallback; 
  UINT FAR* pcRefParent; 
} PROPSHEETPAGE, FAR* LPPROPSHEETPAGE;
typedef const PROPSHEETPAGE FAR* LPCPROPSHEETPAGE;

Members

• dwSize
  Specifies the size, in bytes, of the structure. The size includes any extra application-defined data at the end of the structure.

• dwFlags
  Specifies a bitmask of flags that enable optional attributes of the property sheet page, and indicate the valid members of the PROPSHEETPAGE structure. This member can be any combination of the following values.

  Value	Description
  PSP_DEFAULT	Uses the default meaning for all structure members.
  PSP_DLGINDIRECT	Creates the page from the dialog box template in memory pointed to by the pResource member. The Microsoft Win32® PropertySheet function assumes that the template is in writeable memory; a read-only template will cause an exception on some versions of Windows. If this flag is not set, the page loads the dialog box template from the resource identified by the pszTemplate member.
  PSP_HASHELP	Enables the property sheet Help button when this page is active.
  PSP_USECALLBACK	Calls the function specified by pfnCallback when creating or destroying the property sheet page defined by this structure.
  PSP_HICON	Not supported.
  PSP_PREMATURE	The page is created when the property sheet is created. Usually, the page is not created until the first time it is selected.
  PSP_USEICONID	Not supported.
  PSP__USEREFPARENT	Maintains the reference count specified by pcRefParent for the lifetime of the property sheet page created from this structure.
  PSP_USETITLE	Uses pszTitle as the title of the property sheet dialog box instead of the title stored in the dialog box template.
  PSP_RTLREADING	Reverses the direction in which pszTitle is displayed. Normal windows display all text, including pszTitle, left-to-right (LTR). For languages such as Hebrew or Arabic, that read right-to-left (RTL), a window can be mirrored and all text will be displayed RTL. If PSP_RTLREADING is set, pszTitle will instead read RTL in a normal parent window, and LTR in a mirrored parent window.

• hInstance
  Handle to the instance from which to load the dialog box template, icon, or title string resource.

• pszTemplate
  This parameter is ignored. DLG_PROPSHEET is the default resource identifier for the dialog box template to use to create the page. To adjust the size or other attributes of the parent dialog box for the property sheet, you can edit the corresponding resource (.res) file to the desired size. The corresponding resource file can be found at %_WINCEROOT%\PUBLIC\COMMON\OAK\LIB\<BSPFamily>\RETAIL\<langID>\commctrlbase.res.

• pResource
  Pointer to a dialog box template in memory. The Win32 PropertySheet function assumes that the template is in writeable memory; a read-only template will cause an exception on some versions of Windows. If dwFlags does not include the PSP_DLGINDIRECT value, this member is ignored.

• hIcon
  Ignored. Must be NULL.

• pszIcon
  Ignored. Must be NULL.

• pszTitle
  Pointer to the null-terminated string that contains the title of the property sheet dialog box. This title overrides the title specified in the dialog box template. This member can specify either the identifier of a string resource or the pointer to a string that specifies the title. If dwFlags does not include the PSP_USETITLE value, this member is ignored.

• pfnDlgProc
  Pointer to the dialog box procedure for the page. The dialog box procedure must not call the Win32 EndDialog function.

• lParam
  Application-defined data.

• pfnCallback
  Pointer to an application-defined callback function that is called when the page is created and when it is about to be destroyed. For more information about the Win32 callback function, see PropSheetPageProc. If dwFlags does not include the PSP_USECALLBACK value, this member is ignored.

• pcRefParent
  Pointer to the reference count value. If dwFlags does not include the PSP_USERREFPARENT value, this member is ignored.

Remarks

When the PropertySheet function creates the page, the dialog box procedure for the page receives a WM_INITDIALOG message. The lParam parameter of this message points to the PROPSHEETPAGE structure used to create the page.

Requirements

Header

prsht.h

See Also

Reference

Property Sheets Structures
CreatePropertySheetPage
EndDialog
PropertySheet
PropSheetPageProc
WM_INITDIALOG