PROPSHEETHEADER 構造体

プロパティ シートのフレームとページを定義します。

構文

typedef struct {
    DWORD      dwSize;
    DWORD      dwFlags;
    HWND       hwndParent;
    HINSTANCE  hInstance;
    union {
        HICON   hIcon;
        LPCTSTR pszIcon;
    };
    LPCTSTR  pszCaption;
    UINT     nPages;
    union {
        UINT    nStartPage;
        LPCTSTR pStartPage;
    };
    union {
        LPCPROPSHEETPAGE ppsp;
        HPROPSHEETPAGE   *phpage;
    };
    PFNPROPSHEETCALLBACK pfnCallback;
    union {
        HBITMAP hbmWatermark;
        LPCTSTR pszbmWatermark;
    };
    HPALETTE  hplWatermark;
    union {
        HBITMAP hbmHeader;
        LPCSTR  pszbmHeader;
    };
} PROPSHEETHEADER, *LPPROPSHEETHEADER;

メンバー

dwSize

型: DWORD

この構造体のサイズ (バイト単位)。 プロパティ シート マネージャーは、このメンバーを使用して、使用している PROPSHEETHEADER 構造体のバージョンを決定します。 詳細については、「解説」を参照してください。

dwFlags

型: DWORD

プロパティ シート ページの作成時に使用するオプションを示すフラグ。 このメンバーは、次の値の組み合わせにすることができます。

hwndParent

型: HWND

プロパティ シートの所有者ウィンドウを処理します。

hInstance

種類: HINSTANCE

アイコン、タイトル文字列リソース、開始ページ名、ヘッダー ビットマップ、または透かしを読み込むインスタンスを処理します。 pszIcon、pszCaption、pStartPage、pszbmHeader、または pszbmWatermark メンバーが読み込むリソースを識別する場合は、このメンバーを指定する必要があります。

hIcon

種類: HICON

プロパティ シート ダイアログ ボックスのタイトル バーの小さなアイコンとして使用するアイコンを処理します。 このメンバーは、 dwFlags メンバーにPSH_USEHICONが含まれている場合に使用されます。 このメンバーは、 pszIcon との共用体として宣言されます。

pszIcon

型: LPCTSTR

プロパティ シート ダイアログ ボックスのタイトル バーの小さなアイコンとして使用するアイコン リソース。 このメンバーは、 dwFlags メンバーにPSH_USEICONIDが含まれている場合に使用されます。 このメンバーは、アイコン リソースの識別子、またはアイコン リソースの名前を指定する文字列のアドレスを指定できます。 どちらの場合も、 アイコンは hInstance メンバーによって提供されるインスタンスから読み込まれます。 このメンバーは、 hIcon との共用体として宣言されます。

pszCaption

型: LPCTSTR

プロパティ シート ダイアログ ボックスのタイトル。 このメンバーは、文字列リソースの識別子 ( hInstance メンバーによって指定されたインスタンスから読み込まれる) またはタイトルを指定する文字列のアドレスを指定できます。 dwFlags メンバーにPSH_PROPTITLEが含まれている場合は、 の文字列 Properties がタイトルの先頭に挿入されます。 ウィザード 97 ウィザードでは、このフィールドは無視されます。 Aero ウィザードの場合、PSH_PROPTITLE フラグが設定されているかどうかに関係なく、文字列はキャプションに対して単独で使用されます。

nPages

型: UINT

ppsp 配列または phpage 配列で指定されたプロパティ シート ページの数。

nStartPage

型: UINT

プロパティ シート ダイアログ ボックスの作成時に表示される初期ページの 0 から始まるインデックス。 このメンバーは、 dwFlags メンバーに PSH_USEPSTARTPAGE フラグが含まれていない場合に使用されます。 このメンバーは、 pStartPage を持つ共用体として宣言されます。

pStartPage

型: LPCTSTR

プロパティ シート ダイアログ ボックスの作成時に表示される初期ページの名前。 このメンバーは、 dwFlags メンバーに PSH_USESTARTPAGE フラグが含まれている場合に使用されます。 このメンバーは、文字列リソースの識別子 ( hInstance メンバーによって指定されたインスタンスから読み込まれます) または名前を指定する文字列のアドレスを指定できます。 開始ページ名は、ページのキャプションと一致します。 このメンバーは、 nStartPage を持つ共用体として宣言されます。

ppsp

種類: LPCPROPSHEETPAGE

プロパティ シート内のページを定義する PROPSHEETPAGE 構造体の配列へのポインター。 dwFlags メンバーにPSH_PROPSHEETPAGEが含まれていない場合、このメンバーは無視されます。 PROPSHEETPAGE 構造体のサイズは可変であることに注意してください。 ppsp が指す配列を解析するアプリケーションでは、各ページのサイズを考慮する必要があります。 このメンバーは、 phpage との共用体として宣言されています。

phpage

種類: HPROPSHEETPAGE*

プロパティ シート ページへのハンドルの配列へのポインター。 このメンバーは、 dwFlags メンバーにPSH_PROPSHEETPAGEが含まれていない場合に使用されます。 各ハンドルは、 CreatePropertySheetPage 関数の以前の呼び出しによって作成されている必要があります。 PropertySheet 関数が戻ると、phpage 配列内の HPROPSHEETPAGE ハンドルはすべて破棄されます。 このメンバーは、 ppsp を持つ共用体として宣言されます。

pfnCallback

種類: PFNPROPSHEETCALLBACK

特定のイベントが発生したときに呼び出されるアプリケーション定義のコールバック関数へのポインター。 コールバック関数の詳細については、 PFNPROPSHEETCALLBACK コールバック関数の説明を参照してください。 dwFlags メンバーにPSH_USECALLBACKが含まれていない場合、このメンバーは無視されます。

hbmWatermark

種類: HBITMAP

バージョン 5.80 以降。 透かしビットマップを処理します。 dwFlags メンバーにPSH_USEHBMWATERMARKが含まれていない場合、このメンバーは無視されます。

pszbmWatermark

種類: LPCTSTR

バージョン 5.80 以降。 透かしとして使用するビットマップ リソース。 このメンバーは、ビットマップ リソースの識別子、またはビットマップ リソースの名前を指定する文字列のアドレスを指定できます。 dwFlags メンバーにPSH_USEHBMWATERMARKが含まれている場合、このメンバーは無視されます。

hplWatermark

種類: HPALETTE

バージョン 5.80 以降。 透かしビットマップやヘッダー ビットマップの描画に使用される HPALETTE 構造体。 dwFlags メンバーにPSH_USEHPLWATERMARKが含まれていない場合、このメンバーは無視されます。

hbmHeader

種類: HBITMAP

バージョン 5.80 以降。 ヘッダー ビットマップへのハンドル。 dwFlags メンバーにPSH_USEHBMHEADERが含まれていない場合、このメンバーは無視されます。

pszbmHeader

種類: LPCSTR

バージョン 5.80 以降。 ヘッダーとして使用するビットマップ リソース。 このメンバーは、ビットマップ リソースの識別子、またはビットマップ リソースの名前を指定する文字列のアドレスを指定できます。 dwFlags メンバーにPSH_USEHBMHEADERが含まれている場合、このメンバーは無視されます。

解説

ダイアログ ボックスを拡大する [大きなフォント] などの設定をユーザーが選択すると、開始ページと終了ページに塗りつぶされた透かしも拡大されます。 元のビットマップのサイズと位置は変わりません。 追加領域には、ビットマップの左上隅にあるピクセルの色が塗りつぶされます。

PSH_WIZARD、PSH_WIZARD97、およびPSH_WIZARD_LITEスタイルは相互に互換性がありません。 これらのスタイル フラグの 1 つだけを設定する必要があります。 PSH_AEROWIZARDは、PSH_WIZARDと組み合わせる必要があります。

必要条件