Structure DLGPAGE (compstui.h)

La structure DLGPAGE est utilisée pour spécifier une page de feuille de propriétés dans la fonction ComPropSheet de CPSUI. L’adresse de la structure est incluse dans une structure COMPROPSHEETUI, et toutes les valeurs membres sont fournies par l’appelant ComPropSheet.

Syntaxe

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

Membres

cbSize

Taille fournie par l’appelant, en octets, de la structure DLGPAGE.

Flags

Indicateurs de bits fournis par l’appelant, comme décrit dans le tableau suivant.

Drapeau	Définition
DPF_ICONID_AS_HICON	Si la valeur est définie, IconID contient un handle d’icône. Si ce n’est pas défini, IconID contient un identificateur de ressource d’icône.
DPF_USE_HDLGTEMPLATE	Si elle est définie, hDlgTemplate contient un handle de modèle. Si ce n’est pas le cas, DlgTemplateID contient un identificateur de ressource de modèle.

Facultatif, fourni par l’appelant DLGPROCpointeur typé vers une procédure de boîte de dialogue, utilisé pour traiter les messages envoyés par le système lorsque des événements utilisateur se produisent. Si NULL, CPSUI fournit une procédure de boîte de dialogue. Pour plus d’informations, consultez la section Remarques ci-dessous.

DlgProc

Définit le membre DLGPROCDlgProc.

pTabName

Pointeur fourni par l’appelant vers une chaîne terminée par NULL à afficher sous l’onglet page.

IconID

L’appelant peut être l’un des éléments suivants :

• Identificateur de ressource d’icône. Cela peut être défini par l’application, ou il peut s’agir de l’un des identificateurs de ressource d’icônes IDI_CPSUI préfixés de cpSUI.

• Handle d’icône. Si un handle est spécifié, DPF_ICONID_AS_HICON doit être défini dans le membre Indicateurs.

L’icône spécifiée s’affiche sous l’onglet page. Si cette valeur est égale à zéro, une icône n’est pas affichée.

DUMMYUNIONNAME

Définit l’union DUMMYUNIONNAME.

DUMMYUNIONNAME.DlgTemplateID

Identificateur de ressource fourni par l’appelant pour un modèle de boîte de dialogue. Cela peut faire référence à une ressource DIALOG fournie par l’application, ou il peut s’agir de l’un des identificateurs fournis par CPSUI suivants (définis dans compstui.h) :

Identificateur	Type de page
DP_STD_DOCPROPPAGE1	Page Nontreeview, utilisée pour la page Disposition d’un document d’impression.
DP_STD_DOCPROPPAGE2	Page Nontreeview, utilisée pour la page Papier/Qualité d’un document imprimé.
DP_STD_TREEVIEWPAGE	Page treeview générique.

Les identificateurs fournis par CPSUI font référence aux modèles qui peuvent afficher types d’options CPSUI. La taille de page de ces modèles est de 252 par 216 unités de boîte de dialogue. Pour plus d’informations, consultez CPSUI-Supplied pages et modèles.

Ce membre n’est pas utilisé si DPF_USE_HDLGTEMPLATE est défini dans indicateurs.

DUMMYUNIONNAME.hDlgTemplate

Handle fourni par l’appelant à une structure DLGTEMPLATE.

Utilisé uniquement si DPF_USE_HDLGTEMPLATE est défini dans indicateurs.

Remarques

CPSUI crée une page de feuille de propriétés en allouant une structurePROPSHEETPAGEet en la transmettant à CreatePropertySheetPage. Si l’appelant a spécifié un pointeur typé DLGPROC vers une procédure de boîte de dialogue dans DlgProc, cette procédure est utilisée pour gérer les messages de fenêtre de la page. Si DlgProc est NULL, les procédures de boîte de dialogue de CPSUI sont utilisées.

Lorsque la procédure de boîte de dialogue pointée par DlgProc est appelée avec une valeur de message de WM_INITDIALOG, elle reçoit la structure PROPSHEETPAGE comme entrée, et reçoit également une structure PSPINFO.

Si une procédure de boîte de dialogue fournie par l’appelant gère un message, elle doit retourner une valeur différente de zéro. Si la fonction ne gère pas le message, elle doit retourner zéro, ce qui entraîne la gestion du message par CPSUI.

Exigences

Exigence	Valeur
d’en-tête	compstui.h (include Compstui.h)