PROPSHEETPAGEPROPSHEETPAGE*
*Contents  *Index  *Topic Contents
*Previous Topic: PROPSHEETHEADER
*Next Topic: PSHNOTIFY

PROPSHEETPAGE


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;

#if (_WIN32_IE >= 0x0400)
    LPCTSTR pszHeaderTitle;
    LPCTSTR pszHeaderSubTitle;
#endif
} PROPSHEETPAGE, FAR *LPPROPSHEETPAGE;

This structure defines a page in a property sheet.

dwSize
Size, in bytes, of this structure.
dwFlags
Flags that indicate which options to use when creating the property sheet page. This member can be a combination of the following values:
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 pResource. The PropertySheet function assumes that the template is in memory that can be written; a read-only template will cause an exception in some versions of Windows.
PSP_HASHELP Enables the property sheet Help button when this page is active.
PSP_HIDEHEADER Version 4.71. Causes the wizard property sheet to hide the header area when this page is selected.
PSP_PREMATURE Causes the page to be created when the property sheet is created. If this flag is not specified, the page will not be created until it is selected the first time.
PSP_RTLREADING When this page is active, displays the text of pszTitle using right-to-left reading order on Hebrew or Arabic systems.
PSP_USECALLBACK Calls the function specified by pfnCallback when creating or destroying the property sheet page defined by this structure.
PSP_USEHEADERSUBTITLE Version 4.71. Displays the text in pszHeaderSubTitle as the subtitle of the header area. This flag is ignored if PSP_HIDEHEADER is included or the dwFlags member of the PROPSHEETHEADER structure does not contain the PSH_WIZARD97 flag.
PSP_USEHEADERTITLE Version 4.71. Displays the text in pszHeaderTitle as the title of the header area. This flag is ignored if PSP_HIDEHEADER is included or the dwFlags member of the PROPSHEETHEADER structure does not contain the PSH_WIZARD97 flag.
PSP_USEHICON Uses hIcon as the small icon on the tab for the page.
PSP_USEICONID Uses pszIcon as the name of the icon resource to load and use as the small icon on the tab for the page.
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.
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.
pszTemplate
Dialog box template to use to create the page. This member can specify either the resource identifier of the template or the address of a string that specifies the name of the template. If dwFlags includes PSP_DLGINDIRECT, this member is ignored.
pResource
Address of a dialog box template in memory. The PropertySheet function assumes that the template is in memory that can be written; a read-only template will cause an exception in some versions of Windows. If dwFlags does not include PSP_DLGINDIRECT, this member is ignored.
hIcon
Handle to the icon to use as the icon in the tab of the page. If dwFlags does not include PSP_USEHICON, this member is ignored.
pszIcon
Icon resource to use as the icon in the tab of the page. 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 PSP_USEICONID, this member is ignored.
pszTitle
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 address of a string that specifies the title. If dwFlags does not include PSP_USETITLE, this member is ignored.
pfnDlgProc
Address of the dialog box procedure for the page. Because the pages are created as modeless dialogs, the dialog box procedure must not call the EndDialog function.
lParam
Application-defined data.
pfnCallback
Address of 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 callback function, see PropSheetPageProc. If dwFlags does not include PSP_USECALLBACK, this member is ignored.
pcRefParent
Address of the reference count value. If dwFlags does not include PSP_USEREFPARENT, this member is ignored.
pszHeaderTitle
Version 4.71. Title of the header area. This member is ignored if any of the following are true:
  • The dwFlags member of this structure contains PSP_HIDEHEADER.
  • The dwFlags member of this structure does not contain PSP_USEHEADERTITLE.
  • The dwFlags member of the PROPSHEETHEADER structure does not contain PSH_WIZARD97.
pszHeaderSubTitle
Version 4.71. Subtitle of the header area. This member is ignored if any of the following are true:
  • The dwFlags member of this structure contains PSP_HIDEHEADER.
  • The dwFlags member of this structure does not contain PSP_USEHEADERSUBTITLE.
  • The dwFlags member of the PROPSHEETHEADER structure does not contain PSH_WIZARD97.

Up Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.