Edit

LVGROUPMETRICS structure (commctrl.h)

  • Article

Contains information about the display of groups in a list-view control.

Syntax

typedef struct tagLVGROUPMETRICS {
  UINT     cbSize;
  UINT     mask;
  UINT     Left;
  UINT     Top;
  UINT     Right;
  UINT     Bottom;
  COLORREF crLeft;
  COLORREF crTop;
  COLORREF crRight;
  COLORREF crBottom;
  COLORREF crHeader;
  COLORREF crFooter;
} LVGROUPMETRICS, *PLVGROUPMETRICS;

Members

cbSize

Type: UINT

Size of the LVGROUPMETRICS structure.

mask

Type: UINT

Flags that specify which members contain or are to receive valid data. Can be one or more of the following values.

Value Meaning
LVGMF_BORDERCOLOR
 Not implemented.
LVGMF_BORDERSIZE
 The Left, Top, Right, and Bottom members are valid.
LVGMF_NONE
 No members are valid.
LVGMF_TEXTCOLOR
 Not implemented.

Left

Type: UINT

Specifies the width of the left border in icon, small icon, or tile view.

Top

Type: UINT

Specifies the width of the top border in all group views.

Right

Type: UINT

Specifies the width of the right border in icon, small icon, or tile view.

Bottom

Type: UINT

Specifies the width of the bottom border in all group views.

crLeft

Type: COLORREF

Specifies the color of the left border. Not implemented.

crTop

Type: COLORREF

Specifies the color of the top border. Not implemented.

crRight

Type: COLORREF

Specifies the color of the right border. Not implemented.

crBottom

Type: COLORREF

Specifies the color of the bottom border. Not implemented.

crHeader

Type: COLORREF

Specifies the color of the header text. Not implemented.

crFooter

Type: COLORREF

Specifies the color of the footer text. Not implemented.

Remarks

The width of a border determines the margins of the area within which items are placed. The top border is highlighted when the user moves the cursor over it, and when the user clicks on this border in a list that allows multiple selection, all items in the group are selected.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header commctrl.h

See also

LVM_GETGROUPMETRICS

LVM_SETGROUPMETRICS

ListView_GetGroupMetrics

ListView_SetGroupMetrics

Reference