LVGROUP 結構 (commctrl.h)

發行項
02/26/2024

用來設定和擷取群組。

語法

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	pszHeader 和 cchHeader 成員有效。
LVGF_FOOTER	pszFooter 和 cchFooter 成員有效。
LVGF_STATE	state 和 stateMask 成員有效。
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

群組的標識碼。

stateMask

類型： UINT

用於 LVM_GETGROUPINFO 和 LVM_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

大小，以 TCHAR為單位，由 pszSubtitle 成員指向的緩衝區。如果結構未收到群組的相關信息，則會忽略此成員。

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

控件 imagelist 中標題影像的索引。

iExtendedImage

類型： int

控件 imagelist 中擴充影像的索引。

iFirstItem

類型： int

唯讀。

cItems

類型： UINT

非擁有者數據模式中的唯讀。

pszSubsetTitle

類型： LPWSTR

如果群組不是子集，則為NULL。設定項目資訊時，包含子集標題文字之 Null 終止字串的指標。如果要擷取群組資訊，這個成員會指定接收子集標題文字的緩衝區位址。

cchSubsetTitle

類型： UINT

pszSubsetTitle 成員所指向緩衝區的 TCHAR大小。如果結構未收到群組的相關信息，則會忽略此成員。

備註

此結構中傳回的所有字串都應該視為唯讀。

目前不支援建立子集，而且無法由應用程式設定 pszSubsetTitle 。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
標頭	commctrl.h

共用方式為

LVGROUP 結構 (commctrl.h)

語法

成員

備註

規格需求

意見反應

其他資源