Compartir a través de

Estructura LVGROUP (commctrl.h)

  • Artículo

Se usa para establecer y recuperar grupos.

Sintaxis

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;

Miembros

cbSize

Tipo: UINT

Tamaño de esta estructura, en bytes.

mask

Tipo: UINT

Máscara que especifica qué miembros de la estructura son entradas válidas. Uno o varios de los siguientes valores:

Valor Significado
LVGF_NONE
 Ningún otro elemento es válido.
LVGF_HEADER
 Los miembros pszHeader y cchHeader son válidos.
LVGF_FOOTER
 Los miembros pszFooter y cchFooter son válidos.
LVGF_STATE
 los miembros state y stateMask son válidos.
LVGF_ALIGN
 El miembro uAlign es válido.
LVGF_GROUPID
 El miembro iGroupId es válido.
LVGF_SUBTITLE

Versión 6.00 y posteriores. El miembro pszSubtitle es válido.
LVGF_TASK

Versión 6.00 y posteriores. El miembro pszTask es válido.
LVGF_DESCRIPTIONTOP

Versión 6.00 y posteriores. El miembro pszDescriptionTop es válido.
LVGF_DESCRIPTIONBOTTOM

Versión 6.00 y posteriores. El miembro pszDescriptionBottom es válido.
LVGF_TITLEIMAGE

Versión 6.00 y posteriores. El miembro iTitleImage es válido.
LVGF_EXTENDEDIMAGE

Versión 6.00 y posteriores. El miembro iExtendedImage es válido.
LVGF_ITEMS

Versión 6.00 y posteriores. El miembro cItems es válido.
LVGF_SUBSET

Versión 6.00 y posteriores. El miembro pszSubsetTitle es válido.
LVGF_SUBSETITEMS

Versión 6.00 y posteriores. El miembro cchSubsetTitle es válido.

pszHeader

Tipo: LPWSTR

Puntero a una cadena terminada en null que contiene el texto del encabezado cuando se establece la información del elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto del encabezado.

cchHeader

Tipo: int

Tamaño en TCHARs del búfer al que apunta el miembro pszHeader . Si la estructura no recibe información sobre un grupo, se omite este miembro.

pszFooter

Tipo: LPWSTR

Puntero a una cadena terminada en null que contiene el texto del pie de página cuando se establece la información del elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto del pie de página.

cchFooter

Tipo: int

Tamaño en TCHARs del búfer al que apunta el miembro pszFooter . Si la estructura no recibe información sobre un grupo, se omite este miembro.

iGroupId

Tipo: int

Identificador del grupo.

stateMask

Tipo: UINT

Máscara usada con LVM_GETGROUPINFO y LVM_SETGROUPINFO para especificar qué marcas del valor de estado se recuperan o establecen.

state

Tipo: UINT

Marca que puede tener uno de los valores siguientes:

Valor Significado
LVGS_NORMAL
 Los grupos se expanden, se muestra el nombre del grupo y se muestran todos los elementos del grupo.
LVGS_COLLAPSED
 El grupo está contraído.
LVGS_HIDDEN
 El grupo está oculto.
LVGS_NOHEADER

Versión 6.00 y posteriores. El grupo no muestra un encabezado.
LVGS_COLLAPSIBLE

Versión 6.00 y posteriores. El grupo se puede contraer.
LVGS_FOCUSED

Versión 6.00 y posteriores. El grupo tiene el foco del teclado.
LVGS_SELECTED

Versión 6.00 y posteriores. El grupo está seleccionado.
LVGS_SUBSETED

Versión 6.00 y posteriores. El grupo muestra solo una parte de sus elementos.
LVGS_SUBSETLINKFOCUSED

Versión 6.00 y posteriores. El vínculo de subconjunto del grupo tiene el foco del teclado.

uAlign

Tipo: UINT

Indica la alineación del texto del encabezado o pie de página del grupo. Puede tener uno o varios de los valores siguientes. Use una de las marcas de encabezado. Las marcas de pie de página son opcionales.

Valor Significado
LVGA_FOOTER_CENTER
 El texto del pie de página se centra horizontalmente en la ventana.
LVGA_FOOTER_LEFT
 El texto del pie de página se alinea a la izquierda de la ventana.
LVGA_FOOTER_RIGHT
 El texto del pie de página se alinea a la derecha de la ventana.
LVGA_HEADER_CENTER
 El texto del encabezado se centra horizontalmente en la ventana.
LVGA_HEADER_LEFT
 El texto del encabezado se alinea a la izquierda de la ventana.
LVGA_HEADER_RIGHT
 El texto del encabezado se alinea a la derecha de la ventana.

pszSubtitle

Tipo: LPWSTR

Puntero a una cadena terminada en null que contiene el texto del subtítulo cuando se establece la información del elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto del subtítulo. Este elemento se dibuja bajo el texto del encabezado.

cchSubtitle

Tipo: UINT

Tamaño, en TCHARs, del búfer al que apunta el miembro pszSubtitle . Si la estructura no recibe información sobre un grupo, se omite este miembro.

pszTask

Tipo: LPWSTR

Puntero a una cadena terminada en null que contiene el texto de un vínculo de tarea cuando se establece información de elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto de la tarea. Este elemento se dibuja alineado a la derecha frente al texto del encabezado. Cuando el usuario hace clic en este, el vínculo de tarea genera una notificación LVN_LINKCLICK .

cchTask

Tipo: UINT

Tamaño en TCHARs del búfer al que apunta el miembro pszTask . Si la estructura no recibe información sobre un grupo, se omite este miembro.

pszDescriptionTop

Tipo: LPWSTR

Puntero a una cadena terminada en null que contiene el texto de descripción superior cuando se establece la información del elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto de descripción superior. Este elemento se dibuja frente a la imagen de título cuando hay una imagen de título, ninguna imagen extendida y uAlign==LVGA_HEADER_CENTER.

cchDescriptionTop

Tipo: UINT

Tamaño en TCHARdel búfer al que apunta el miembro pszDescriptionTop . Si la estructura no recibe información sobre un grupo, se omite este miembro.

pszDescriptionBottom

Tipo: LPWSTR

Puntero a una cadena terminada en null que contiene el texto de descripción inferior cuando se establece la información del elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto de descripción inferior. Este elemento se dibuja en el texto de descripción superior cuando hay una imagen de título, sin imagen extendida y uAlign==LVGA_HEADER_CENTER.

cchDescriptionBottom

Tipo: UINT

Tamaño en TCHARs del búfer al que apunta el miembro pszDescriptionBottom . Si la estructura no recibe información sobre un grupo, se omite este miembro.

iTitleImage

Tipo: int

Índice de la imagen de título en la lista de imágenes de control.

iExtendedImage

Tipo: int

Índice de la imagen extendida en la lista de imágenes de control.

iFirstItem

Tipo: int

Solo lectura.

cItems

Tipo: UINT

Solo lectura en modo de datos que no son propietarios.

pszSubsetTitle

Tipo: LPWSTR

NULL si group no es un subconjunto. Puntero a una cadena terminada en null que contiene el texto del título del subconjunto cuando se establece la información del elemento. Si se recupera información de grupo, este miembro especifica la dirección del búfer que recibe el texto del título del subconjunto.

cchSubsetTitle

Tipo: UINT

Tamaño en TCHARs del búfer al que apunta el miembro pszSubsetTitle . Si la estructura no recibe información sobre un grupo, se omite este miembro.

Comentarios

Todas las cadenas devueltas en esta estructura deben tratarse como de solo lectura.

Actualmente no se admite la creación de subconjuntos y las aplicaciones no pueden establecer pszSubsetTitle .

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Encabezado commctrl.h