LVGROUP 结构 (commctrl.h)

用于设置和检索组。

语法

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;

成员

cbSize

类型: UINT

此结构的大小(以字节为单位)。

mask

类型: UINT

用于指定结构的哪些成员是有效输入的掩码。 以下一个或多个值:

含义
LVGF_NONE
没有其他项有效。
LVGF_HEADER
pszHeadercchHeader 成员有效。
LVGF_FOOTER
pszFootercchFooter 成员有效。
LVGF_STATE
statestateMask 成员有效。
LVGF_ALIGN
uAlign 成员有效。
LVGF_GROUPID
iGroupId 成员有效。
LVGF_SUBTITLE

版本 6.00 及更高版本pszSubtitle 成员有效。

LVGF_TASK

版本 6.00 及更高版本pszTask 成员有效。

LVGF_DESCRIPTIONTOP

版本 6.00 及更高版本pszDescriptionTop 成员有效。

LVGF_DESCRIPTIONBOTTOM

版本 6.00 及更高版本pszDescriptionBottom 成员有效。

LVGF_TITLEIMAGE

版本 6.00 及更高版本iTitleImage 成员有效。

LVGF_EXTENDEDIMAGE

版本 6.00 及更高版本iExtendedImage 成员有效。

LVGF_ITEMS

版本 6.00 及更高版本cItems 成员有效。

LVGF_SUBSET

版本 6.00 及更高版本pszSubsetTitle 成员有效。

LVGF_SUBSETITEMS

版本 6.00 及更高版本cchSubsetTitle 成员有效。

pszHeader

类型: LPWSTR

指向以 null 结尾的字符串的指针,该字符串在设置项信息时包含标头文本。 如果正在检索组信息,则此成员指定接收标头文本的缓冲区的地址。

cchHeader

类型: int

pszHeader 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

pszFooter

类型: LPWSTR

指向以 null 结尾的字符串的指针,该字符串在设置项信息时包含页脚文本。 如果正在检索组信息,则此成员指定接收页脚文本的缓冲区的地址。

cchFooter

类型: int

pszFooter 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

iGroupId

类型: int

组的 ID。

stateMask

类型: UINT

LVM_GETGROUPINFOLVM_SETGROUPINFO 一起使用的掩码,用于指定正在检索或设置 状态 值中的哪些标志。

state

类型: UINT

可以具有以下值之一的标志:

含义
LVGS_NORMAL
展开组,显示组名称,并显示组中的所有项。
LVGS_COLLAPSED
该组已折叠。
LVGS_HIDDEN
组处于隐藏状态。
LVGS_NOHEADER

版本 6.00 及更高版本。 组不显示标头。

LVGS_COLLAPSIBLE

版本 6.00 及更高版本。 该组可以折叠。

LVGS_FOCUSED

版本 6.00 及更高版本。 组具有键盘焦点。

LVGS_SELECTED

版本 6.00 及更高版本。 已选择组。

LVGS_SUBSETED

版本 6.00 及更高版本。 组仅显示其项的一部分。

LVGS_SUBSETLINKFOCUSED

版本 6.00 及更高版本。 组的子集链接具有键盘焦点。

uAlign

类型: UINT

指示组的页眉或页脚文本的对齐方式。 它可以具有以下一个或多个值。 使用其中一个标头标志。 页脚标志是可选的。

含义
LVGA_FOOTER_CENTER
页脚文本在窗口中水平居中。
LVGA_FOOTER_LEFT
页脚文本在窗口左侧对齐。
LVGA_FOOTER_RIGHT
页脚文本在窗口右侧对齐。
LVGA_HEADER_CENTER
标题文本在窗口中水平居中。
LVGA_HEADER_LEFT
标题文本在窗口左侧对齐。
LVGA_HEADER_RIGHT
标题文本在窗口右侧对齐。

pszSubtitle

类型: LPWSTR

指向以 null 结尾的字符串的指针,该字符串在设置项目信息时包含副标题文本。 如果正在检索组信息,则此成员指定接收副标题文本的缓冲区的地址。 此元素在标题文本下绘制。

cchSubtitle

类型: UINT

pszSubtitle 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

pszTask

类型: LPWSTR

指向以 null 结尾的字符串的指针,该字符串包含设置项信息时任务链接的文本。 如果正在检索组信息,则此成员指定接收任务文本的缓冲区的地址。 此项在标题文本的正对面右对齐绘制。 用户单击任务链接时,会生成 LVN_LINKCLICK 通知。

cchTask

类型: UINT

pszTask 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

pszDescriptionTop

类型: LPWSTR

指向以 null 结尾的字符串的指针,该字符串在设置项信息时包含顶部说明文本。 如果正在检索组信息,则此成员指定接收顶部说明文本的缓冲区的地址。 当有标题图像、没有扩展图像和 uAlign==LVGA_HEADER_CENTER时,此项将绘制在标题图像的对面。

cchDescriptionTop

类型: UINT

pszDescriptionTop 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

pszDescriptionBottom

类型: LPWSTR

指向以 null 结尾的字符串的指针,该字符串在设置项信息时包含底部说明文本。 如果正在检索组信息,则此成员指定接收底部说明文本的缓冲区的地址。 当有标题图像、没有扩展图像和 uAlign==LVGA_HEADER_CENTER时,将在顶部说明文本下绘制此项。

cchDescriptionBottom

类型: UINT

pszDescriptionBottom 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

iTitleImage

类型: int

控件图像列表中的标题图像的索引。

iExtendedImage

类型: int

控件映像列表中的扩展图像的索引。

iFirstItem

类型: int

只读。

cItems

类型: UINT

非所有者数据模式下的只读。

pszSubsetTitle

类型: LPWSTR

如果组不是子集,则为 NULL。 指向以 null 结尾的字符串的指针,该字符串在设置项信息时包含子集标题文本。 如果正在检索组信息,则此成员指定接收子集标题文本的缓冲区的地址。

cchSubsetTitle

类型: UINT

pszSubsetTitle 成员指向的缓冲区的大小(以 TCHAR为单位)。 如果结构未接收有关组的信息,则忽略此成员。

备注

此结构中返回的所有字符串都应视为只读。

目前不支持创建子集,并且应用程序无法设置 pszSubsetTitle

要求

   
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
标头 commctrl.h