LvwGroup class

One group of a ListView: its header, its footer, its state and its items. A program gets one from the LvwGroups collection and its Add method, from an item’s Group, and from the control’s events that name a group.

Dim Group As LvwGroup
Set Group = ListView1.Groups.Add(, "docs", "Documents", LvwGroupHeaderAlignmentCenter, "3 files")
Group.Hint = "Opened this week"
Group.Collapsible = True
Debug.Print Group.Header; " | "; Group.Footer; " | "; Group.Hint
Debug.Print Group.HeaderAlignment; Group.Collapsible; Group.Collapsed
' Output:
' Documents | 3 files | Opened this week
'  2 TrueFalse

A program cannot make an LvwGroup object with New. Most of a group’s members need visual styles; without them a program has no groups at all.

Properties

Collapsed

Whether the group’s items are hidden under its header. Boolean. Default: False. A change raises GroupCollapsedChanged.

Collapsible

Whether the group’s header has a button with which the user collapses and expands the group. Boolean. Default: False.

The text under the group’s items. String. Default: the Footer of Add.

FooterAlignment

Where the footer’s text is. A member of LvwGroupFooterAlignmentConstants. Another value raises run-time error 380.

The text of the group’s header. String. It is the default member.

HeaderAlignment

Where the header’s text is. A member of LvwGroupHeaderAlignmentConstants. Another value raises run-time error 380.

Height, Left, Top, Width

The place and the size of the group’s header in the control, in the scale units of the control’s container. Single, read-only: an assignment raises run-time error 383.

Hint

A text shown under the header, in smaller type. String. Default: empty.

ID

The number by which Windows knows the group. Long, read-only. The groups of a control get 1, 2, 3 and on, in the order they are added, and a group keeps its ID; so after a group is added in front of others, or removed, the ID of a group is not its Index.

Icon

The number or the key of the header’s icon in the image list of GroupIcons. Variant. 0 when the group has none. An assignment takes a number or a key; a key that the image list does not have raises run-time error 35601.

IconIndex

The number of the header’s icon in the image list, also when Icon names it by its key. Long, read-only.

Index

The number of the group in the LvwGroups collection, from 1. Long, read-only.

Key

The group’s key in the LvwGroups collection. String. An assignment gives the group another key; an empty string takes the key away, and a key that another group has raises run-time error 457.

A text in the group’s header that the user clicks as a link, which raises GroupLinkClick. String. Default: empty, with which there is no link.

ListItemCount

The number of items in the group. Long, read-only.

ListItemIndices

The numbers of the items in the group, as a Collection, in the order they are shown. Read-only.

Position

The place of the group among the others as they are shown, from 1. Long, read-only: an assignment raises run-time error 383. It differs from Index when the groups are sorted.

Selected

Whether the group is selected. Boolean. Default: False. Setting it to True selects the group and gives it the focus. A change raises GroupSelectedChanged.

ShowHeader

Whether the group’s header is shown. Boolean. Default: True.

Subseted

Whether the group shows only its first GroupSubsetCount items, with its SubsetLink under them. Boolean. Default: False.

The text of the link with which the user shows all the items of a Subseted group. String. Default: empty.

SubsetLinkSelected

Whether the group’s subset link has the focus. Boolean. Default: False.

Tag

A value of the program’s own, which the control does not use. Variant: it holds a value of any type, an object included, which is assigned with Set. A new group has an empty string.

See Also

  • Groups – the groups in the control
  • LvwGroups class – the collection of the groups
  • LvwListItem class – the Group of an item