PROPSHEETPAGE 結構
定義屬性工作表中的頁面。
語法
typedef struct {
DWORD dwSize;
DWORD dwFlags;
HINSTANCE hInstance;
union {
LPCSTR pszTemplate;
PROPSHEETPAGE_RESOURCE pResource;
};
union {
HICON hIcon;
LPCSTR pszIcon;
};
LPCSTR pszTitle;
DLGPROC pfnDlgProc;
LPARAM lParam;
LPFNPSPCALLBACK pfnCallback;
UINT *pcRefParent;
LPCTSTR pszHeaderTitle;
LPCTSTR pszHeaderSubTitle;
HANDLE hActCtx;
union
{
HBITMAP hbmHeader;
LPCSTR pszbmHeader;
}
} PROPSHEETPAGE, *LPPROPSHEETPAGE;
成員
dwSize
類型: DWORD
這個結構的大小,以位元組為單位。
dwFlags
類型: DWORD
旗標,指出建立屬性工作表頁面時要使用的選項。 這個成員可以是下列值的組合。
值 | 意義 |
---|---|
PSP_DEFAULT | 使用所有結構成員的預設意義。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_DLGINDIRECT | 從 pResource 成員所指向記憶體中的對話方塊範本建立頁面。 PropertySheet函式假設記憶體中的範本不受寫入保護。 唯讀範本會導致某些版本的 Windows 發生例外狀況。 |
PSP_HASHELP | 啟用頁面使用中時的屬性工作表 [說明 ] 按鈕。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_HIDEHEADER | 5.80 版和更新版本。 使精靈屬性工作表在選取頁面時隱藏頁首區域。 如果已提供浮水印,則會在頁面左側繪製。 此旗標應設定為歡迎和完成頁面,並省略內部頁面。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_PREMATURE | 4.71 版或更新版本。 建立屬性工作表時,會導致建立頁面。 如果未指定此旗標,則在第一次選取頁面之前,將不會建立頁面。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_RTLREADING | 反轉 pszTitle 顯示的方向。 一般視窗會顯示所有文字,包括 pszTitle、由左至右 (LTR) 。 對於從右至左讀取 RTL () 的希伯來文或阿拉伯文等語言,可以鏡像視窗並顯示所有文字 RTL。 如果已設定PSP_RTLREADING, pszTitle 會改為在一般父視窗中讀取 RTL,並在鏡像父視窗中讀取 LTR。 |
PSP_USECALLBACK | 建立或終結這個結構所定義的屬性工作表頁面時,呼叫 pfnCallback 成員所指定的函式。 |
PSP_USEFUSIONCONTEXT | 6.0 版和更新版本。 使用啟用內容。 若要使用啟用內容,您必須設定此旗標,並將啟用內容控制碼指派給 hActCtx。 請參閱。 |
PSP_USEHEADERSUBTITLE | 5.80 版或更新版本。 將 pszHeaderSubTitle 成員所指向的字串顯示為 Wizard97 頁面標題區域的子標題。 若要使用此旗標,您也必須在相關聯PROPSHEETHEADER結構的dwFlags成員中設定PSH_WIZARD97旗標。 如果已設定PSP_HIDEHEADER,則會忽略PSP_USEHEADERSUBTITLE旗標。 在 [登入樣式精靈] 中,標題會出現在工作區頂端附近。 |
PSP_USEHEADERTITLE | 5.80 版或更新版本。 將 pszHeaderTitle 成員所指向的字串顯示為 Wizard97 內部頁面標頭中的標題。 您也必須在相關聯PROPSHEETHEADER結構的dwFlags成員中設定PSH_WIZARD97旗標。 如果已設定PSP_HIDEHEADER,則會忽略PSP_USEHEADERTITLE旗標。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_USEHICON | 使用 hIcon 作為頁面索引標籤上的小型圖示。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_USEICONID | 使用 pszIcon 作為圖示資源的名稱,以載入並使用 作為頁面索引標籤上的小型圖示。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
PSP_USEREFPARENT | 維護 pcRefParent 成員針對從這個結構建立之屬性工作表頁面存留期所指定的參考計數。 |
PSP_USETITLE | 使用 pszTitle 成員做為屬性工作表對話方塊的標題,而不是儲存在對話方塊範本中的標題。 使用 (PSH_AEROWIZARD) 時,不支援此旗標。 |
hInstance
類型: HINSTANCE
處理要從中載入圖示或字串資源的實例。 如果 pszIcon、 pszTitle、 pszHeaderTitle或 pszHeaderSubTitle 成員識別要載入的資源,則必須指定 hInstance 。
pszTemplate
類型: LPCSTR
用來建立頁面的對話方塊範本。 此成員可以指定範本的資源識別碼,或指定範本名稱之字串的位址。 如果 已設定 dwFlags 成員中的PSP_DLGINDIRECT旗標, 則會忽略 pszTemplate 。 這個成員會宣告為具有 pResource的聯集。
pResource
類型: LPCDLGTEMPLATE
記憶體中對話方塊範本的指標。 PropertySheet函式假設範本不受寫入保護。 唯讀範本會導致某些版本的 Windows 發生例外狀況。 若要使用此成員,您必須在 dwFlags 成員中設定PSP_DLGINDIRECT旗標。 這個成員會宣告為 pszTemplate的聯集。
hIcon
類型: HICON
要用來作為頁面索引標籤中圖示的圖示控制碼。 如果 dwFlags 成員不包含PSP_USEHICON,則會忽略此成員。 這個成員會宣告為 pszIcon的聯集。
pszIcon
類型: LPCSTR
要用來作為頁面索引標籤中圖示的圖示資源。 這個成員可以指定圖示資源的識別碼,或指定圖示資源名稱的字串位址。 若要使用此成員,您必須在 dwFlags 成員中設定PSP_USEICONID旗標。 此成員會宣告為 具有 hIcon的等位。
pszTitle
類型: LPCSTR
屬性工作表對話方塊的標題。 此標題會覆寫對話方塊範本中指定的標題。 這個成員可以指定字串資源的識別碼或指定標題的字串位址。 若要使用此成員,您必須在 dwFlags 成員中設定PSP_USETITLE旗標。
pfnDlgProc
類型: DLGPROC
頁面對話方塊程式的指標。 由於頁面會建立為無強制回應對話方塊,因此對話方塊程式不得呼叫 EndDialog 函式。
lParam
類型: LPARAM
建立頁面時,頁面 的 PROPSHEETPAGE 結構複本會傳遞至具有 WM_INITDIALOG訊息的 對話方塊程式。 提供 lParam成員,可讓您將應用程式特定資訊傳遞至對話方塊程式。 它不會影響頁面本身。
pfnCallback
類型: LPFNPSPCALLBACK
應用程式定義回呼函式的指標,該函式會在建立頁面時呼叫,以及即將終結時呼叫。 如需回呼函式的詳細資訊,請參閱 LPFNPSPCALLBACKA 回呼函式。 若要使用此成員,您必須在 dwFlags 成員中設定PSP_USECALLBACK旗標。
pcRefParent
類型: UINT*
參考計數值的指標。 若要使用此成員,您必須在 dwFlags 成員中設定PSP_USEREFPARENT旗標。
注意
建立屬性工作表頁面時, pcRefParent 所指向的值會遞增。 您可以在PROPSHEETHEADER的dwFlags成員中設定 PSH_PROPSHEETPAGE 旗標,並呼叫PropertySheet函式,以隱含方式建立屬性工作表頁面。 您可以使用 CreatePropertySheetPage 函式明確地執行此動作。 當屬性工作表頁面終結時, pcRefParent 成員所指向的值會遞減。 這會在屬性工作表終結時自動發生。 您可以使用 DestroyPropertySheetPage 函式明確地終結屬性工作表頁面。
pszHeaderTitle
類型: LPCTSTR
5.80 版或更新版本。 標頭區域的標題。 若要在 Wizard97 樣式精靈下使用此成員,您也必須執行下列動作:
- 在 dwFlags 成員中設定PSP_USEHEADERTITLE旗標。
- 在頁面PROPSHEETHEADER結構的dwFlags成員中設定PSH_WIZARD97旗標。
- 請確定 未設定 dwFlags 成員中的PSP_HIDEHEADER旗標。
pszHeaderSubTitle
類型: LPCTSTR
5.80 版或更新版本。 標題區域的子標題。 若要使用此成員,您必須執行下列動作:
- 在 dwFlags 成員中設定PSP_USEHEADERSUBTITLE旗標。
- 在頁面PROPSHEETHEADER結構的dwFlags成員中設定PSH_WIZARD97旗標。
- 請確定 未設定 dwFlags 成員中的PSP_HIDEHEADER旗標。
注意
使用 (樣式精靈 (PSH_AEROWIZARD) 時,會忽略此成員
hActCtx
類型: HANDLE
6.0 版或更新版本。 啟用內容控制碼。 將此成員設定為使用 CreateActCtx建立啟用內容時所傳回的控制碼。 系統會在建立對話方塊之前啟動此內容。 如果您使用全域資訊清單,就不需要使用此成員。
hbmHeader
類型: HBITMAP
這個成員會宣告為 pszbmHeader的聯集。
pszbmHeader
類型: LPCSTR
這個成員會宣告為 hbmHeader的聯集。
備註
Comctl32.dll第 6 版和更新版本無法轉散發。 若要使用第 6 版或更新版本Comctl32.dll,請在資訊清單中指定.dll檔案。 如需資訊清單的詳細資訊,請參閱 啟用視覺化樣式。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
標頭 | Prsht.h |
Unicode 與 ANSI 名稱 | PROPSHEETHEADERW (Unicode) 和 PROPSHEETHEADERA (ANSI) |