PROPSHEETHEADER

Article
06/30/2006

This structure defines the frame and pages of a property sheet.

typedef struct _PROPSHEETHEADER { 
DWORD dwSize; 
DWORD dwFlags; 
HWND hwndParent; 
HINSTANCE hInstance; 
union {
HICON hIcon; 
LPCWSTR pszIcon; 
};
LPCWSTR pszCaption; 
UINT nPages; 
union {
UINT nStartPage; 
LPCWSTR pStartPage; 
};
union {
LPCPROPSHEETPAGE ppsp; 
HPROPSHEETPAGE FAR *phpage; 
};
PFNPROPSHEETCALLBACK pfnCallback;} 
PROPSHEETHEADER, FAR *LPPROPSHEETHEADER;
typedef const PROPSHEETHEADER FAR *LPCPROPSHEETHEADER;

Members

dwSize
Specifies the size, in bytes, of this structure.

dwFlags
Specifies a bitmask of flags that indicate which options to use when creating the property sheet page. It can be a combination of the following values:

Value	Description
PSH_DEFAULT	Uses the default meaning for all structure members.
PSH_HASHELP	Displays the property sheet Help button. The Help button is enabled only when the PSP_HASHELP flag is set in the PROPSHEETPAGE structure for the active page. If any of the initial property sheet pages set the PSP_HASHELP flag, the Help button is automatically displayed regardless of the PSH_HASHELP flag. However, PSH_HASHELP is useful when none of the initial pages set PSP_HASHELP, but pages added later might.
PSH_HEADER	Version 4.71. Indicates that a header bitmap will be used. If this value does not include PSH_USEHBMHEADER, the header bitmap is obtained from pszbmHeader. If this value includes PSH_USEHBMHEADER, the header bitmap is obtained from hbmHeader. This flag is ignored if PSH_WIZARD97 is not included.
PSH_MODELESS	Causes the PropertySheet function to create the property sheet as a modeless dialog instead of as a modal dialog. When this flag is set, PropertySheet returns immediately after the dialog is created, and the return value from PropertySheet is the window handle to the property sheet dialog.
PSH_NOAPPLYNOW	Removes the Apply Now button.
PSH_PROPSHEETPAGE	Uses ppsp and ignores phpage when creating the pages for the property sheet.
PSH_PROPTITLE	Displays the string Properties for, followed by the string specified by pszCaption, in the title bar of the property sheet.
PSH_RTLREADING	Displays the title of the property sheet dialog using right-to-left reading order on Hebrew or Arabic systems.
PSH_STRETCHWATERMARK	Version 4.71. Stretches the bitmap to fit the background of the property sheet instead of tiling the watermark and/or header bitmap. This flag is ignored if PSH_WIZARD97 and PSH_WATERMARK or PSH_HEADER are not included.
PSH_USECALLBACK	Calls the function specified by pfnCallback when initializing the property sheet defined by this structure.
PSH_USEHBMHEADER	Version 4.71. Obtains the header bitmap from hbmHeader instead of pszbmHeader. This flag is ignored if PSH_WIZARD97 and PSH_HEADER are not included.
PSH_USEHBMWATERMARK	Version 4.71. Obtains the watermark bitmap from hbmWatermark instead of pszbmWatermark. This flag is ignored if PSH_WIZARD97 and PSH_WATERMARK are not included.
PSH_USEHICON	Not supported.
PSH_USEHPLWATERMARK	Version 4.71. Obtains the HPALETTE for drawing the watermark bitmap and/or header bitmap from hplWatermark instead of using the default palette. This flag is ignored if PSH_WIZARD97 and PSH_WATERMARK or PSH_HEADER are not included.
PSH_USEICONID	Not supported.
PSH_USEPAGELANG	Version 4.71. The language for the property sheet will be taken from the first pages resource.
PSH_USEPSTARTPAGE	Uses pStartPage and ignores nStartPage when displaying the initial page of the property sheet.
PSH_WATERMARK	Version 4.71. Specifies that a watermark bitmap will be used. If this value does not include PSH_USEHBMWATERMARK, the watermark bitmap is obtained from pszbmWatermark. If this value includes PSH_USEHBMWATERMARK, the header bitmap is obtained from hbmWatermark. This flag is ignored if PSH_WIZARD97 is not included.
PSH_WIZARD	Creates a wizard property sheet.
PSH_WIZARD97	Creates a wizard property sheet that allows a header and/or watermark bitmap to be displayed in the background. This and all Wizard 97-associated flags are not currently implemented.
PSH_WIZARDCONTEXTHELP	Adds a system menu to the wizard property sheet. This flag is ignored if PSH_WIZARD or PSH_WIZARD97 is not included.
PSH_WIZARDHASFINISH	Always displays the Finish button on the wizard. This flag is ignored if PSH_WIZARD or PSH_WIZARD97 is not included.

hwndParent
Handle to the property sheets owner window.
hInstance
Handle to the instance from which to load the icon or title string resource. If pszIcon or pszCaption identifies a resource to load, this member must be specified.
hIcon
Handle to the icon to use as the small icon in the title bar of the property sheet dialog box. If dwFlags does not include PSH_USEHICON, this member is ignored.
pszIcon
Pointer to an icon resource to use as the small icon in the title bar of the property sheet dialog box. This member can specify either the identifier of the icon resource or the address of the string that specifies the name of the icon resource. If dwFlags does not include PSH_USEICONID, this member is ignored.
pszCaption
Pointer to the null-terminated string that contains the title of the property sheet dialog box. This member can specify either the identifier of a string resource or the address of a string that specifies the title. If dwFlags includes PSH_PROPTITLE, the string Properties for is inserted at the beginning of the title.
nPages
Number of elements in the phpage array.
nStartPage
Zero-based index of the initial page that appears when the property sheet dialog box is created.
pStartPage
Pointer to the name of the initial page that appears when the property sheet dialog box is created. This member can specify either the identifier of a string resource or the address of a string that specifies the name.
ppsp
Pointer to an array of PROPSHEETPAGE structures that define the pages in the property sheet. If dwFlags does not include PSH_PROPSHEETPAGE, this member is ignored.
phpage
Pointer to an array of handles to the property sheet pages. Each handle must have been created by a previous call to the CreatePropertySheetPage function. If dwFlags includes PSH_PROPSHEETPAGE, this member is ignored.
pfnCallback
Pointer to an application-defined callback function that is called when the property sheet is initialized. For more information about the callback function, see the description of the PropSheetProc function. If dwFlags does not include PSH_USECALLBACK, this member is ignored.
hbmWatermark
Version 4.71. Handle to the watermark bitmap. If dwFlags does not include PSH_USEHBMWATERMARK, this member is ignored.
pszbmWatermark
Version 4.71. Pointer to a bitmap resource to use as the watermark. This member can specify either the identifier of the bitmap resource or the address of the string that specifies the name of the bitmap resource. If dwFlags includes PSH_USEHBMWATERMARK, this member is ignored.
hplWatermark
Version 4.71. HPALETTE used for drawing the watermark bitmap and/or header bitmap. If dwFlags does not include PSH_USEHPLWATERMARK, this member is ignored.
hbmHeader
Version 4.71. Handle to the header bitmap. If dwFlags does not include PSH_USEHBMHEADER, this member is ignored.
pszbmHeader
Version 4.71. Pointer to a bitmap resource to use as the header. This member can specify either the identifier of the bitmap resource or the address of the string that specifies the name of the bitmap resource. If dwFlags includes PSH_USEHBMHEADER, this member is ignored.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Prsht.h

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

Last updated on Tuesday, July 13, 2004

PROPSHEETHEADER

Additional resources