LVGROUP-Struktur (commctrl.h)

  • Artikel

Wird zum Festlegen und Abrufen von Gruppen verwendet.

Syntax

typedef struct tagLVGROUP {
  UINT   cbSize;
  UINT   mask;
  LPWSTR pszHeader;
  int    cchHeader;
  LPWSTR pszFooter;
  int    cchFooter;
  int    iGroupId;
  UINT   stateMask;
  UINT   state;
  UINT   uAlign;
  LPWSTR pszSubtitle;
  UINT   cchSubtitle;
  LPWSTR pszTask;
  UINT   cchTask;
  LPWSTR pszDescriptionTop;
  UINT   cchDescriptionTop;
  LPWSTR pszDescriptionBottom;
  UINT   cchDescriptionBottom;
  int    iTitleImage;
  int    iExtendedImage;
  int    iFirstItem;
  UINT   cItems;
  LPWSTR pszSubsetTitle;
  UINT   cchSubsetTitle;
} LVGROUP, *PLVGROUP;

Member

cbSize

Typ: UINT

Größe dieser Struktur in Bytes.

mask

Typ: UINT

Maske, die angibt, welche Member der -Struktur gültige Eingaben sind. Mindestens einer der folgenden Werte:

Wert Bedeutung
LVGF_NONE
 Es sind keine anderen Elemente gültig.
LVGF_HEADER
 pszHeader - und cchHeader-Member sind gültig.
LVGF_FOOTER
 pszFooter - und cchFooter-Member sind gültig.
LVGF_STATE
 state - und stateMask-Member sind gültig.
LVGF_ALIGN
 uAlign-Member ist gültig.
LVGF_GROUPID
 Das iGroupId-Element ist gültig.
LVGF_SUBTITLE

Version 6.00 und höher. Das pszSubtitle-Element ist gültig.
LVGF_TASK

Version 6.00 und höher. Das pszTask-Element ist gültig.
LVGF_DESCRIPTIONTOP

Version 6.00 und höher. Das pszDescriptionTop-Element ist gültig.
LVGF_DESCRIPTIONBOTTOM

Version 6.00 und höher. Das pszDescriptionBottom-Element ist gültig.
LVGF_TITLEIMAGE

Version 6.00 und höher. Das iTitleImage-Element ist gültig.
LVGF_EXTENDEDIMAGE

Version 6.00 und höher. Das iExtendedImage-Element ist gültig.
LVGF_ITEMS

Version 6.00 und höher. Das cItems-Element ist gültig.
LVGF_SUBSET

Version 6.00 und höher. Das pszSubsetTitle-Element ist gültig.
LVGF_SUBSETITEMS

Version 6.00 und höher. Das cchSubsetTitle-Element ist gültig.

pszHeader

Typ: LPWSTR

Zeiger auf eine NULL-endende Zeichenfolge, die den Headertext enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den Headertext empfängt.

cchHeader

Typ: int

Größe in TCHARs des Puffers, auf den der pszHeader-Member verweist. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

pszFooter

Typ: LPWSTR

Zeiger auf eine NULL-endende Zeichenfolge, die den Fußzeilentext enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den Fußzeilentext empfängt.

cchFooter

Typ: int

Größe in TCHARs des Puffers, auf den der pszFooter-Member verweist. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

iGroupId

Typ: int

ID der Gruppe.

stateMask

Typ: UINT

Maske, die mit LVM_GETGROUPINFO und LVM_SETGROUPINFO verwendet wird, um anzugeben, welche Flags im Zustandswert abgerufen oder festgelegt werden.

state

Typ: UINT

Flag, das einen der folgenden Werte aufweisen kann:

Wert Bedeutung
LVGS_NORMAL
 Gruppen werden erweitert, der Gruppenname wird angezeigt, und alle Elemente in der Gruppe werden angezeigt.
LVGS_COLLAPSED
 Die Gruppe ist reduziert.
LVGS_HIDDEN
 Die Gruppe ist ausgeblendet.
LVGS_NOHEADER

Version 6.00 und höher. Die Gruppe zeigt keinen Header an.
LVGS_COLLAPSIBLE

Version 6.00 und höher. Die Gruppe kann reduziert werden.
LVGS_FOCUSED

Version 6.00 und höher. Die Gruppe verfügt über den Tastaturfokus.
LVGS_SELECTED

Version 6.00 und höher. Die Gruppe ist ausgewählt.
LVGS_SUBSETED

Version 6.00 und höher. Die Gruppe zeigt nur einen Teil ihrer Elemente an.
LVGS_SUBSETLINKFOCUSED

Version 6.00 und höher. Der Teilmengenlink der Gruppe hat den Tastaturfokus.

uAlign

Typ: UINT

Gibt die Ausrichtung des Kopf- oder Fußzeilentexts für die Gruppe an. Sie kann einen oder mehrere der folgenden Werte aufweisen. Verwenden Sie eines der Headerflags. Fußzeilenflags sind optional.

Wert Bedeutung
LVGA_FOOTER_CENTER
 Der Fußzeilentext wird im Fenster horizontal zentriert.
LVGA_FOOTER_LEFT
 Fußzeilentext wird links im Fenster ausgerichtet.
LVGA_FOOTER_RIGHT
 Der Fußzeilentext wird rechts vom Fenster ausgerichtet.
LVGA_HEADER_CENTER
 Kopfzeilentext wird im Fenster horizontal zentriert.
LVGA_HEADER_LEFT
 Der Kopfzeilentext wird links im Fenster ausgerichtet.
LVGA_HEADER_RIGHT
 Der Kopfzeilentext wird rechts vom Fenster ausgerichtet.

pszSubtitle

Typ: LPWSTR

Zeiger auf eine NULL-endende Zeichenfolge, die den Untertiteltext enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den Untertiteltext empfängt. Dieses Element wird unter dem Kopfzeilentext gezeichnet.

cchSubtitle

Typ: UINT

Größe des Puffers, auf den das pszSubtitle-Element verweist, in TCHARs. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

pszTask

Typ: LPWSTR

Zeiger auf eine NULL-endende Zeichenfolge, die den Text für einen Vorgangslink enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den Vorgangstext empfängt. Dieses Element wird rechtsbündig gegenüber dem Kopfzeilentext gezeichnet. Wenn der Benutzer auf sie klickt, generiert der Aufgabenlink eine LVN_LINKCLICK Benachrichtigung.

cchTask

Typ: UINT

Größe in TCHARs des Puffers, auf den der pszTask-Member verweist. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

pszDescriptionTop

Typ: LPWSTR

Zeiger auf eine NULL-endende Zeichenfolge, die den obersten Beschreibungstext enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den obersten Beschreibungstext empfängt. Dieses Element wird gegenüber dem Titelbild gezeichnet, wenn ein Titelbild, kein erweitertes Bild und uAlign==LVGA_HEADER_CENTER.

cchDescriptionTop

Typ: UINT

Größe in TCHARs des Puffers, auf den der pszDescriptionTop-Member verweist. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

pszDescriptionBottom

Typ: LPWSTR

Zeiger auf eine NULL-endende Zeichenfolge, die den unteren Beschreibungstext enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den unteren Beschreibungstext empfängt. Dieses Element wird unter dem oberen Beschreibungstext gezeichnet, wenn ein Titelbild, kein erweitertes Bild und uAlign==LVGA_HEADER_CENTER.

cchDescriptionBottom

Typ: UINT

Größe in TCHARs des Puffers, auf den der pszDescriptionBottom-Member verweist. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

iTitleImage

Typ: int

Index des Titelbilds in der Steuerelementbildliste.

iExtendedImage

Typ: int

Index des erweiterten Bilds in der Steuerelementbildliste.

iFirstItem

Typ: int

Schreibgeschützt.

cItems

Typ: UINT

Schreibgeschützt im Nicht-Besitzer-Datenmodus.

pszSubsetTitle

Typ: LPWSTR

NULL , wenn group keine Teilmenge ist. Zeiger auf eine NULL-endende Zeichenfolge, die den Teilmengentiteltext enthält, wenn Elementinformationen festgelegt werden. Wenn Gruppeninformationen abgerufen werden, gibt dieses Element die Adresse des Puffers an, der den Teilmengentiteltext empfängt.

cchSubsetTitle

Typ: UINT

Größe in TCHARs des Puffers, auf den der pszSubsetTitle-Member verweist. Wenn die Struktur keine Informationen zu einer Gruppe empfängt, wird dieses Element ignoriert.

Hinweise

Alle in dieser Struktur zurückgegebenen Zeichenfolgen sollten als schreibgeschützt behandelt werden.

Die Erstellung von Teilmengen wird derzeit nicht unterstützt, und pszSubsetTitle kann nicht von Anwendungen festgelegt werden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Kopfzeile commctrl.h