DLGPAGE 構造体 (compstui.h)

  • [アーティクル]

DLGPAGE 構造体は、CPSUI の ComPropSheet 関数にプロパティ シート ページを指定するために使用されます。 構造体のアドレスは COMPROPSHEETUI 構造体に含まれており、すべてのメンバー値は ComPropSheet 呼び出し元によって提供されます。

構文

typedef struct _DLGPAGE {
  WORD      cbSize;
  WORD      Flags;
  DLGPROC   DlgProc;
  LPTSTR    pTabName;
  ULONG_PTR IconID;
  union {
    WORD   DlgTemplateID;
    HANDLE hDlgTemplate;
  } DUMMYUNIONNAME;
} DLGPAGE, *PDLGPAGE;

メンバー

cbSize

DLGPAGE 構造体の呼び出し元が指定したサイズ (バイト単位)。

Flags

次の表で説明するように、呼び出し元から提供されるビット フラグ。

フラグ 定義
DPF_ICONID_AS_HICON 設定されている場合、IconID にはアイコン ハンドルが含まれます。 設定されていない場合、IconID にはアイコン リソース識別子が含まれます。
DPF_USE_HDLGTEMPLATE 設定されている場合、 hDlgTemplate にはテンプレート ハンドルが含まれます。 設定されていない場合、 DlgTemplateID にはテンプレート リソース識別子が含まれます。

ユーザー イベントが発生したときにシステムから送信されるメッセージを処理するために使用される、ダイアログ ボックス プロシージャへの呼び出し元指定の DLGPROC 型ポインター (省略可能)。 NULL の場合、CPSUI はダイアログ ボックス プロシージャを提供します。 詳細については、以下の「解説」セクションを参照してください。

DlgProc

DLGPROC メンバー DlgProc を定義します。

pTabName

ページ タブに表示される NULL で終わる文字列への呼び出し元指定ポインター。

IconID

呼び出し元から提供される には、次のいずれかを指定できます。

  • アイコン リソース識別子。 これは、アプリケーション定義でも、CPSUI 提供のIDI_CPSUIプレフィックス付きアイコン リソース識別子の 1 つでもかまいません。

  • アイコン ハンドル。 ハンドルを指定する場合は、 flags メンバーでDPF_ICONID_AS_HICONを設定する必要があります。

指定したアイコンがページ タブに表示されます。この値が 0 の場合、アイコンは表示されません。

DUMMYUNIONNAME

DUMMYUNIONNAME 共用体を定義します。

DUMMYUNIONNAME.DlgTemplateID

ダイアログ ボックス テンプレートの呼び出し元から指定されたリソース識別子。 これは、アプリケーション提供の DIALOG リソースを参照することも、次の CPSUI 提供の識別子 (compstui.h で定義) のいずれかを指定することもできます。

識別子 ページの種類
DP_STD_DOCPROPPAGE1 印刷ドキュメントの レイアウト ページに使用される非ツリービュー ページ。
DP_STD_DOCPROPPAGE2 印刷ドキュメントの 用紙/品質 ページに使用される非ツリービュー ページ。
DP_STD_TREEVIEWPAGE 汎用ツリービュー ページ。

CPSUI 提供の ID は、 CPSUI オプション・タイプを表示できるテンプレートを参照します。 これらのテンプレートのページ サイズは、252 ~ 216 のダイアログ ボックス ユニットです。 詳細については、「 CPSUI 提供のページとテンプレート」を参照してください。

フラグ でDPF_USE_HDLGTEMPLATEが設定されている場合、このメンバーは使用されません。

DUMMYUNIONNAME.hDlgTemplate

DLGTEMPLATE 構造体への呼び出し元指定ハンドル。

フラグでDPF_USE_HDLGTEMPLATEが設定されている場合にのみ使用 されます。

注釈

CPSUI は、 PROPSHEETPAGE 構造体を割り当て、 それを CreatePropertySheetPage に渡すことによって、プロパティ シート ページを作成します。 呼び出し元が DlgProc のダイアログ ボックス プロシージャへの DLGPROC 型ポインターを指定した場合、そのプロシージャはページのウィンドウ メッセージを処理するために使用されます。 DlgProc が NULL の場合は、CPSUI 独自のダイアログ ボックス プロシージャが使用されます。

DlgProc が指すダイアログ ボックス プロシージャがメッセージ値 WM_INITDIALOGで呼び出されると、 PROPSHEETPAGE 構造体を入力として受け取り、 PSPINFO 構造体も受け取ります。

呼び出し元が指定したダイアログ ボックス プロシージャがメッセージを処理する場合は、0 以外の値を返す必要があります。 関数がメッセージを処理しない場合は、0 を返す必要があります。これにより、CPSUI によってメッセージが処理されます。

要件

要件 値
Header compstui.h (Compstui.h を含む)