PROPSHEETPAGE-Struktur

Definiert eine Seite in einem Eigenschaftenblatt.

Syntax

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;

Member

dwSize

Art: DWORD

Größe dieser Struktur in Byte.

dwFlags

Art: DWORD

Flags, die angeben, welche Optionen beim Erstellen der Eigenschaftenblattseite verwendet werden. Dieser Member kann eine Kombination der folgenden Werte sein.

Wert Bedeutung
PSP_DEFAULT Verwendet die Standard-Bedeutung für alle Strukturmember. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_DLGINDIRECT Erstellt die Seite aus der Dialogfeldvorlage im Arbeitsspeicher, auf den der pResource-Member verweist. Die PropertySheet-Funktion geht davon aus, dass die Vorlage, die sich im Arbeitsspeicher befindet, nicht schreibgeschützt ist. Eine schreibgeschützte Vorlage verursacht in einigen Versionen von Windows eine Ausnahme.
PSP_HASHELP Aktiviert die Hilfeschaltfläche des Eigenschaftenblatts, wenn die Seite aktiv ist. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_HIDEHEADER Version 5.80 und höher. Bewirkt, dass das Eigenschaftenblatt des Assistenten den Kopfzeilenbereich ausblendet, wenn die Seite ausgewählt wird. Wenn ein Wasserzeichen angegeben wurde, wird es auf der linken Seite gezeichnet. Dieses Flag sollte für Willkommens- und Vervollständigungsseiten festgelegt und für innenseitige Seiten weggelassen werden. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_PREMATURE Version 4.71 oder höher. Bewirkt, dass die Seite erstellt wird, wenn das Eigenschaftenblatt erstellt wird. Wenn dieses Flag nicht angegeben ist, wird die Seite erst erstellt, wenn sie zum ersten Mal ausgewählt wird. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_RTLREADING Kehrt die Richtung um, in der pszTitle angezeigt wird. Normale Fenster zeigen den gesamten Text an, einschließlich pszTitle, von links nach rechts (LTR). Für Sprachen wie Hebräisch oder Arabisch, die von rechts nach links (RTL) lesen, kann ein Fenster gespiegelt werden, und der gesamte Text wird RTL angezeigt. Wenn PSP_RTLREADING festgelegt ist, liest pszTitle stattdessen RTL in einem normalen übergeordneten Fenster und LTR in einem gespiegelten übergeordneten Fenster.
PSP_USECALLBACK Ruft die funktion auf, die vom pfnCallback-Member beim Erstellen oder Zerstören der durch diese Struktur definierten Eigenschaftenblattseite angegeben wird.
PSP_USEFUSIONCONTEXT Version 6.0 und höher. Verwenden Sie einen Aktivierungskontext. Um einen Aktivierungskontext zu verwenden, müssen Sie dieses Flag festlegen und das Aktivierungskontexthandle hActCtx zuweisen. Weitere Informationen finden Sie in den Hinweisen.
PSP_USEHEADERSUBTITLE Version 5.80 oder höher. Zeigt die Zeichenfolge an, auf die der pszHeaderSubTitle-Member verweist, als Untertitel des Kopfzeilenbereichs einer Wizard97-Seite. Um dieses Flag zu verwenden, müssen Sie auch das PSH_WIZARD97-Flag im dwFlags-Element der zugeordneten PROPSHEETHEADER-Struktur festlegen. Das PSP_USEHEADERSUBTITLE-Flag wird ignoriert, wenn PSP_HIDEHEADER festgelegt ist. In Assistenten im Aero-Stil wird der Titel am oberen Rand des Clientbereichs angezeigt.
PSP_USEHEADERTITLE Version 5.80 oder höher. Zeigt die Zeichenfolge an, auf die das pszHeaderTitle-Element als Titel in der Kopfzeile einer Assistenten97-Innenseite zeigt. Sie müssen auch das PSH_WIZARD97-Flag im dwFlags-Element der zugeordneten PROPSHEETHEADER-Struktur festlegen. Das PSP_USEHEADERTITLE-Flag wird ignoriert, wenn PSP_HIDEHEADER festgelegt ist. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_USEHICON Verwendet hIcon als kleines Symbol auf der Registerkarte für die Seite. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_USEICONID Verwendet pszIcon als Namen der Symbolressource, die geladen und als kleines Symbol auf der Registerkarte für die Seite verwendet werden soll. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.
PSP_USEREFPARENT Verwaltet die vom pcRefParent-Element angegebene Verweisanzahl für die Lebensdauer der Eigenschaftenblattseite, die aus dieser Struktur erstellt wurde.
PSP_USETITLE Verwendet den PszTitle-Member als Titel des Eigenschaftenblattdialogfelds anstelle des Titels, der in der Dialogfeldvorlage gespeichert ist. Dieses Flag wird bei Verwendung des Aero-Style-Assistenten (PSH_AEROWIZARD) nicht unterstützt.

hInstance

Typ: HINSTANCE

Handle mit dem instance, aus dem ein Symbol oder eine Zeichenfolgenressource geladen werden soll. Wenn das Element pszIcon, pszTitle, pszHeaderTitle oder pszHeaderSubTitle eine zu ladende Ressource identifiziert, muss hInstance angegeben werden.

pszTemplate

Typ: LPCSTR

Dialogfeldvorlage, die zum Erstellen der Seite verwendet werden soll. Dieses Element kann entweder den Ressourcenbezeichner der Vorlage oder die Adresse einer Zeichenfolge angeben, die den Namen der Vorlage angibt. Wenn das PSP_DLGINDIRECT-Flag im dwFlags-Element festgelegt ist, wird pszTemplate ignoriert. Dieser Member wird als Union mit pResource deklariert.

pResource

Typ: LPCDLGTEMPLATE

Zeiger auf eine Dialogfeldvorlage im Arbeitsspeicher. Die PropertySheet-Funktion geht davon aus, dass die Vorlage nicht schreibgeschützt ist. Eine schreibgeschützte Vorlage verursacht in einigen Versionen von Windows eine Ausnahme. Um dieses Element verwenden zu können, müssen Sie das PSP_DLGINDIRECT-Flag im dwFlags-Element festlegen. Dieser Member wird mit pszTemplate als Union deklariert.

hIcon

Typ: HICON

Handle mit dem Symbol, das als Symbol auf der Registerkarte der Seite verwendet werden soll. Wenn das dwFlags-Element nicht PSP_USEHICON enthält, wird dieser Member ignoriert. Dieses Element wird als Union mit pszIcon deklariert.

pszIcon

Typ: LPCSTR

Symbolressource, die als Symbol auf der Registerkarte der Seite verwendet werden soll. Dieses Element kann entweder den Bezeichner der Symbolressource oder die Adresse der Zeichenfolge angeben, die den Namen der Symbolressource angibt. Um dieses Element verwenden zu können, müssen Sie das PSP_USEICONID-Flag im dwFlags-Element festlegen. Dieses Element wird als Union mit hIcon deklariert.

pszTitle

Typ: LPCSTR

Titel des Eigenschaftenblattdialogfelds. Dieser Titel überschreibt den in der Dialogfeldvorlage angegebenen Titel. Dieses Element kann entweder den Bezeichner einer Zeichenfolgenressource oder die Adresse einer Zeichenfolge angeben, die den Titel angibt. Um dieses Element verwenden zu können, müssen Sie das PSP_USETITLE-Flag im dwFlags-Element festlegen.

pfnDlgProc

Typ: DLGPROC

Zeiger auf die Dialogfeldprozedur für die Seite. Da die Seiten als moduslose Dialogfelder erstellt werden, darf die Dialogfeldprozedur die EndDialog-Funktion nicht aufrufen.

lParam

Typ: LPARAM

Wenn die Seite erstellt wird, wird eine Kopie der PROPSHEETPAGE-Struktur der Seite mit einer WM_INITDIALOG Meldung an die Dialogfeldprozedur übergeben. Das lParam-Element wird bereitgestellt, damit Sie anwendungsspezifische Informationen an die Dialogfeldprozedur übergeben können. Dies hat keine Auswirkungen auf die eigentliche Seite.

pfnCallback

Typ: LPFNPSPCALLBACK

Zeiger auf eine anwendungsdefinierte Rückruffunktion, die aufgerufen wird, wenn die Seite erstellt wird und wann sie zerstört werden soll. Weitere Informationen zur Rückruffunktion finden Sie unter LPFNPSPCALLBACKA-Rückruffunktion. Um dieses Element verwenden zu können, müssen Sie das PSP_USECALLBACK-Flag im dwFlags-Element festlegen.

pcRefParent

Typ: UINT*

Zeiger auf den Wert für die Verweisanzahl. Um diesen Member verwenden zu können, müssen Sie das PSP_USEREFPARENT-Flag im dwFlags-Element festlegen.

Hinweis

Wenn eine Eigenschaftenblattseite erstellt wird, wird der Wert erhöht, auf den pcRefParent verweist. Sie erstellen implizit eine Eigenschaftenblattseite, indem Sie das PSH_PROPSHEETPAGE-Flag im dwFlags-Element von PROPSHEETHEADER festlegen und die PropertySheet-Funktion aufrufen. Sie können dies explizit mithilfe der CreatePropertySheetPage-Funktion tun. Wenn eine Eigenschaftenblattseite zerstört wird, wird der Wert, auf den der pcRefParent-Member verweist, verringert. Dies erfolgt automatisch, wenn das Eigenschaftenblatt zerstört wird. Sie können eine Eigenschaftenblattseite explizit zerstören, indem Sie die DestroyPropertySheetPage-Funktion verwenden.

pszHeaderTitle

Typ: LPCTSTR

Version 5.80 oder höher. Titel des Kopfzeilenbereichs. Um dieses Element im Assistenten 97-Stil zu verwenden, müssen Sie auch die folgenden Schritte ausführen:

  • Legen Sie das PSP_USEHEADERTITLE-Flag im dwFlags-Element fest.
  • Legen Sie das PSH_WIZARD97-Flag im dwFlags-Element der PROPSHEETHEADER-Struktur der Seite fest.
  • Stellen Sie sicher, dass das PSP_HIDEHEADER-Flag im dwFlags-Element nicht festgelegt ist.

pszHeaderSubTitle

Typ: LPCTSTR

Version 5.80 oder höher. Untertitel des Kopfzeilenbereichs. Um diesen Member verwenden zu können, müssen Sie die folgenden Schritte ausführen:

  • Legen Sie das PSP_USEHEADERSUBTITLE-Flag im dwFlags-Element fest.
  • Legen Sie das PSH_WIZARD97-Flag im dwFlags-Element der PROPSHEETHEADER-Struktur der Seite fest.
  • Stellen Sie sicher, dass das PSP_HIDEHEADER-Flag im dwFlags-Element nicht festgelegt ist.

Hinweis

Dieser Member wird ignoriert, wenn der Aero-Style-Assistent (PSH_AEROWIZARD) verwendet wird.

hActCtx

Typ: HANDLE

Version 6.0 oder höher. Ein Aktivierungskontexthandle. Legen Sie diesen Member auf das Handle fest, das zurückgegeben wird, wenn Sie den Aktivierungskontext mit CreateActCtx erstellen. Das System aktiviert diesen Kontext, bevor das Dialogfeld erstellt wird. Sie müssen diesen Member nicht verwenden, wenn Sie ein globales Manifest verwenden.

hbmHeader

Typ: HBITMAP

Dieses Element wird mit pszbmHeader als Union deklariert.

pszbmHeader

Typ: LPCSTR

Dieser Member wird mit hbmHeader als Union deklariert.

Bemerkungen

Comctl32.dll Version 6 und höher sind nicht verteilbar. Um Comctl32.dll Version 6 oder höher zu verwenden, geben Sie die .dll-Datei in einem Manifest an. Weitere Informationen zu Manifesten finden Sie unter Aktivieren von visuellen Formatvorlagen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Header Prsht.h
Unicode- und ANSI-Name PROPSHEETHEADERW (Unicode) und PROPSHEETHEADERA (ANSI)