Partager via

Structure PROPSHEETHEADER

  • Article

Définit le cadre et les pages d’une feuille de propriétés.

Syntaxe

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;

Membres

dwSize

Type : DWORD

Taille, en octets, de cette structure. Le gestionnaire de feuilles de propriétés utilise ce membre pour déterminer la version de la structure PROPSHEETHEADER que vous utilisez. Pour plus d'informations, consultez la section Notes.

dwFlags

Type : DWORD

Indicateurs qui spécifient quelles options utiliser pour créer la page de feuille de propriétés. Ce membre peut être une combinaison des valeurs suivantes.

Valeur Signification
PSH_DEFAULT (0x00000000) Utilise la signification par défaut pour tous les membres de la structure et crée une feuille de propriétés normale. Cet indicateur a la valeur zéro et n’est pas combiné avec d’autres indicateurs.
PSH_AEROWIZARD (0x00004000) Version 6.00 et ultérieures. Crée une feuille de propriétés de l’Assistant qui utilise le style Aero. L’indicateur PSH_WIZARD doit également être défini. Le modèle d’appartement à thread unique (STA) doit être utilisé.
PSH_HASHELP (0x00000200) Permet aux pages de feuille de propriétés d’afficher un bouton Aide . Vous devez également définir l’indicateur PSP_HASHELP dans la structure PROPSHEETPAGE de la page lors de la création de la page. Si l’une des pages initiales de la feuille de propriétés active un bouton Aide , PSH_HASHELP est automatiquement définie. Si aucune des pages initiales n’active un bouton Aide , vous devez définir explicitement PSH_HASHELP si vous souhaitez avoir des boutons d’aide sur les pages qui peuvent être ajoutées ultérieurement. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_HEADER (0x00080000) Version 5.80 et ultérieures. Indique qu’une bitmap d’en-tête sera utilisée avec un Assistant Wizard97. Vous devez également définir l’indicateur PSH_WIZARD97. Si l’indicateur PSH_USEHBMHEADER est défini, la bitmap d’en-tête est obtenue à partir du membre hbmHeader . Sinon, la bitmap d’en-tête est obtenue à partir du membre pszbmHeader . Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_HEADERBITMAP (0x08000000) Version 6.00 et ultérieures. Le membre pszbmHeader spécifie une bitmap qui s’affiche dans la zone d’en-tête. Doit être utilisé en combinaison avec PSH_AEROWIZARD.
PSH_MODELESS (0x00000400) La fonction PropertySheet crée la feuille de propriétés sous la forme d’une boîte de dialogue sans mode plutôt que d’une boîte de dialogue modale. Lorsque cet indicateur est défini, PropertySheet retourne immédiatement après la création de la boîte de dialogue, et la valeur de retour de PropertySheet est le handle de fenêtre de la boîte de dialogue de la feuille de propriétés. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_NOAPPLYNOW (0x00000080) Supprime le bouton Appliquer . Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_NOCONTEXTHELP (0x02000000) Version 5.80 et ultérieures. Supprime le bouton d’aide contextuel (« ? »), qui est généralement présent dans la barre légende des feuilles de propriétés. Cet indicateur n’est pas valide pour les Assistants. Consultez À propos des feuilles de propriétés pour savoir comment supprimer le bouton d’aide de la barre d’légende pour les versions antérieures des contrôles courants. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_NOMARGIN (0x10000000) Version 6.00 ou ultérieure. Spécifie qu’aucune marge n’est insérée entre la page et le cadre. Doit être utilisé en combinaison avec PSH_AEROWIZARD.
PSH_PROPSHEETPAGE (0x00000008) Utilise le membre ppsp et ignore le membre phpage lors de la création des pages de la feuille de propriétés.
PSH_PROPTITLE (0x00000001) Indique que pszCaption est le nom de la chose pour laquelle les propriétés sont affichées. Windows effectue un ajustement dépendant de la version et de la langue au légende. Par exemple, en anglais, l’expression « Properties for » est précédée d’un pszCaption non vide (et si le pszCaption produit un légende vide, le titre est simplement « Properties »). Si cet indicateur est omis, pszCaption est utilisé sans modifications.
PSH_RESIZABLE (0x04000000) Permet à l’Assistant d’être redimensionné par l’utilisateur. Les boutons Agrandir et réduire apparaissent dans le cadre de l’Assistant et le cadre est de taille. Pour utiliser cet indicateur, vous devez également définir PSH_AEROWIZARD.
PSH_RTLREADING (0x00000800) Définit la feuille de propriétés ou la fenêtre de l’Assistant sur l’ordre de lecture de droite à gauche (RTL), adapté aux langues comme l’hébreu et l’arabe. Si cet indicateur n’est pas spécifié, les fenêtres de feuille de propriétés sont par défaut dans l’ordre de lecture de gauche à droite (LTR) et les fenêtres de l’Assistant correspondent à l’ordre de lecture de la page active.
PSH_STRETCHWATERMARK (0x00040000) Étire le filigrane dans les Assistants de style Wizard97. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD. Cet indicateur de style est uniquement inclus pour assurer la compatibilité descendante pour certaines applications. Son utilisation n’est pas recommandée et elle est uniquement prise en charge par les versions 4.0 et 4.01 des contrôles courants. Avec les contrôles communs version 5.80 et ultérieures, cet indicateur est ignoré.
PSH_USECALLBACK (0x00000100) Appelle la fonction spécifiée par le paramètre pfnCallback lorsque certains événements se produisent. Pour plus d’informations, consultez la description de la fonction de rappel PFNPROPSHEETCALLBACK .
PSH_USEHBMHEADER (0x00100000) Version 5.80. Obtient la bitmap d’en-tête à partir du membre hbmHeader au lieu du membre pszbmHeader . Vous devez également définir l’indicateur PSH_AEROWIZARD ou l’indicateur PSH_WIZARD97 avec l’indicateur PSH_HEADER.
PSH_USEHBMWATERMARK (0x00010000) Version 5.80. Obtient la bitmap de filigrane à partir du membre hbmWatermark au lieu du membre pszbmWatermark . Vous devez également définir PSH_WIZARD97 et PSH_WATERMARK. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_USEHICON (0x00000002) Utilise hIcon comme petite icône dans la barre de titre de la boîte de dialogue feuille de propriétés.
PSH_USEHPLWATERMARK (0x00020000) Version 5.80. Utilise la structure HPALETTE vers laquelle pointe le membre hplWatermark au lieu de la palette par défaut pour dessiner la bitmap de filigrane et/ou la bitmap d’en-tête d’un Assistant Wizard97. Vous devez également définir PSH_WIZARD97 et PSH_WATERMARK ou PSH_HEADER. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_USEICONID (0x00000004) Utilise pszIcon comme nom de la ressource d’icône à charger et à utiliser comme petite icône dans la barre de titre de la boîte de dialogue de la feuille de propriétés.
PSH_USEPAGELANG (0x00200000) Version 5.80. Spécifie que la langue de la feuille de propriétés sera extraite de la ressource de la première page. Cette page doit être spécifiée par l’identificateur de ressource.
PSH_USEPSTARTPAGE (0x00000040) Utilise le membre pStartPage au lieu du membre nStartPage lors de l’affichage de la page initiale de la feuille de propriétés.
PSH_WATERMARK (0x00008000) Version 5.80. Spécifie qu’une bitmap de filigrane sera utilisée avec un Assistant Wizard97 sur les pages qui ont le style PSP_HIDEHEADER. Vous devez également définir l’indicateur PSH_WIZARD97. La bitmap de filigrane est obtenue à partir du membre pszbmWatermark , sauf si PSH_USEHBMWATERMARK est défini. Dans ce cas, la bitmap d’en-tête est obtenue à partir du membre hbmWatermark . Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_WIZARD (0x00000020) Crée une feuille de propriétés de l’Assistant. Lorsque vous utilisez PSH_AEROWIZARD, vous devez également définir cet indicateur.
PSH_WIZARD97 (0x01000000) Version 5.80. Crée une feuille de propriétés de style Wizard97, qui prend en charge les bitmaps dans l’en-tête des pages intérieures et sur le côté gauche des pages extérieures. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_WIZARDCONTEXTHELP (0x00001000) Ajoute un bouton d’aide contextuel (« ? »), qui est généralement absent de la barre de légende d’un Assistant. Cet indicateur n’est pas valide pour les feuilles de propriétés standard. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.
PSH_WIZARDHASFINISH (0x00000010) Affiche toujours le bouton Terminer dans l’Assistant. Vous devez également définir PSH_WIZARD, PSH_WIZARD97 ou PSH_AEROWIZARD.
PSH_WIZARD_LITE (0x00400000) Version 5.80. Utilise le style Wizard-lite. Ce style est similaire en apparence à PSH_WIZARD97, mais il est implémenté comme PSH_WIZARD. Il existe peu de restrictions quant à la façon dont les pages sont mises en forme. Par instance, il n’y a pas de bordures appliquées, et le style PSH_WIZARD_LITE ne peigne pas les bitmaps en filigrane et en-tête comme Wizard97. Cet indicateur n’est pas pris en charge conjointement avec PSH_AEROWIZARD.

hwndParent

Type : HWND

Gérez la fenêtre propriétaire de la feuille de propriétés.

hInstance

Type : HINSTANCE

Gérez l’instance à partir de laquelle charger l’icône, la ressource de chaîne de titre, le nom de page de départ, la bitmap d’en-tête ou le filigrane. Si le membre pszIcon, pszCaption, pStartPage, pszbmHeader ou pszbmWatermark identifie une ressource à charger, ce membre doit être spécifié.

hIcon

Type : HICON

Handle vers l’icône à utiliser comme petite icône dans la barre de titre de la boîte de dialogue feuille de propriétés. Ce membre est utilisé si le membre dwFlags inclut PSH_USEHICON. Ce membre est déclaré en tant qu’union avec pszIcon.

pszIcon

Type : LPCTSTR

Ressource icône à utiliser comme petite icône dans la barre de titre de la boîte de dialogue feuille de propriétés. Ce membre est utilisé si le membre dwFlags inclut PSH_USEICONID. Ce membre peut spécifier l’identificateur de la ressource d’icône ou l’adresse de la chaîne qui spécifie le nom de la ressource d’icône. Dans les deux cas, l’icône est chargée à partir du instance fourni par le membre hInstance. Ce membre est déclaré en tant qu’union avec hIcon.

pszCaption

Type : LPCTSTR

Titre de la boîte de dialogue de la feuille de propriétés. Ce membre peut spécifier l’identificateur d’une ressource de chaîne (chargée à partir du instance spécifié par le membre hInstance) ou l’adresse d’une chaîne qui spécifie le titre. Si le membre dwFlags inclut PSH_PROPTITLE, la chaîne Properties pour est insérée au début du titre. Ce champ est ignoré pour les Assistants Wizard97. Pour les Assistants Aero, la chaîne seule est utilisée pour le légende, que l’indicateur PSH_PROPTITLE soit défini ou non.

nPages

Type : UINT

Nombre de pages de feuille de propriétés fournies dans le tableau ppsp ou phpage .

nStartPage

Type : UINT

Index de base zéro de la page initiale qui s’affiche lors de la création de la boîte de dialogue de la feuille de propriétés. Ce membre est utilisé si le membre dwFlags n’inclut pas l’indicateur PSH_USEPSTARTPAGE. Ce membre est déclaré en tant qu’union avec pStartPage.

pStartPage

Type : LPCTSTR

Nom de la page initiale qui apparaît lors de la création de la boîte de dialogue de la feuille de propriétés. Ce membre est utilisé si le membre dwFlags inclut l’indicateur PSH_USESTARTPAGE. Ce membre peut spécifier l’identificateur d’une ressource de chaîne (chargée à partir du instance spécifié par le membre hInstance) ou l’adresse d’une chaîne qui spécifie le nom. Le nom de la page de démarrage est mis en correspondance avec les légendes des pages. Ce membre est déclaré en tant qu’union avec nStartPage.

ppsp

Type : LPCPROPSHEETPAGE

Pointeur vers un tableau de structures PROPSHEETPAGE qui définissent les pages dans la feuille de propriétés. Si le membre dwFlags n’inclut pas PSH_PROPSHEETPAGE, ce membre est ignoré. Notez que la structure PROPSHEETPAGE est de taille variable. Les applications qui analysent le tableau pointé par ppsp doivent prendre en compte la taille de chaque page. Ce membre est déclaré en tant qu’union avec phpage.

phpage

Type : HPROPSHEETPAGE*

Pointeur vers un tableau de handles vers les pages de feuille de propriétés. Ce membre est utilisé si le membre dwFlags n’inclut pas PSH_PROPSHEETPAGE. Chaque handle doit avoir été créé par un appel précédent à la fonction CreatePropertySheetPage . Lorsque la fonction PropertySheet est retournée, tous les handles HPROPSHEETPAGE dans le tableau phpage ont été détruits. Ce membre est déclaré en tant qu’union avec ppsp.

pfnCallback

Type : PFNPROPSHEETCALLBACK

Pointeur vers une fonction de rappel définie par l’application appelée lorsque certains événements se produisent. Pour plus d’informations sur la fonction de rappel, consultez la description de la fonction de rappel PFNPROPSHEETCALLBACK . Si le membre dwFlags n’inclut pas PSH_USECALLBACK, ce membre est ignoré.

hbmWatermark

Type : HBITMAP

Version 5.80 ou ultérieure. Handle vers la bitmap en filigrane. Si le membre dwFlags n’inclut pas PSH_USEHBMWATERMARK, ce membre est ignoré.

pszbmWatermark

Type : LPCTSTR

Version 5.80 ou ultérieure. Ressource bitmap à utiliser comme filigrane. Ce membre peut spécifier l’identificateur de la ressource bitmap ou l’adresse de la chaîne qui spécifie le nom de la ressource bitmap. Si le membre dwFlags inclut PSH_USEHBMWATERMARK, ce membre est ignoré.

hplWatermark

Type : HPALETTE

Version 5.80 ou ultérieure. Structure HPALETTE utilisée pour dessiner la bitmap de filigrane et/ou l’image bitmap d’en-tête. Si le membre dwFlags n’inclut pas PSH_USEHPLWATERMARK, ce membre est ignoré.

hbmHeader

Type : HBITMAP

Version 5.80 ou ultérieure. Gérez l’en-tête bitmap. Si le membre dwFlags n’inclut pas PSH_USEHBMHEADER, ce membre est ignoré.

pszbmHeader

Type : LPCSTR

Version 5.80 ou ultérieure. Ressource bitmap à utiliser comme en-tête. Ce membre peut spécifier l’identificateur de la ressource bitmap ou l’adresse de la chaîne qui spécifie le nom de la ressource bitmap. Si le membre dwFlags inclut PSH_USEHBMHEADER, ce membre est ignoré.

Notes

Si l’utilisateur choisit un paramètre tel que Polices volumineuses, qui agrandit la boîte de dialogue, le filigrane peint sur les pages de début et de fin est également agrandi. La taille et la position de l’image bitmap d’origine resteront identiques. La zone supplémentaire est remplie avec la couleur du pixel dans le coin supérieur gauche de la bitmap.

Les styles PSH_WIZARD, PSH_WIZARD97 et PSH_WIZARD_LITE sont incompatibles. Un seul de ces indicateurs de style doit être défini. PSH_AEROWIZARD doit être combiné avec PSH_WIZARD.

Spécifications

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
En-tête Prsht.h
Noms Unicode et ANSI PROPSHEETHEADERW (Unicode) et PROPSHEETHEADERA (ANSI)