Edit

Share via

BUTTON_SPLITINFO structure (commctrl.h)

  • Article

Contains information that defines a split button (BS_SPLITBUTTON and BS_DEFSPLITBUTTON styles). Used with the BCM_GETSPLITINFO and BCM_SETSPLITINFO messages.

Syntax

typedef struct tagBUTTON_SPLITINFO {
  UINT       mask;
  HIMAGELIST himlGlyph;
  UINT       uSplitStyle;
  SIZE       size;
} BUTTON_SPLITINFO, *PBUTTON_SPLITINFO;

Members

mask

Type: UINT

A set of flags that specify which members of this structure contain data to be set or which members are being requested. Set this member to one or more of the following flags.

Value Meaning
BCSIF_GLYPH
 himlGlyph is valid.
BCSIF_IMAGE
 himlGlyph is valid. Use when uSplitStyle is set to BCSS_IMAGE.
BCSIF_SIZE
 size is valid.
BCSIF_STYLE
 uSplitStyle is valid.

himlGlyph

Type: HIMAGELIST

A handle to the image list. The provider retains ownership of the image list and is ultimately responsible for its disposal.

uSplitStyle

Type: UINT

The split button style. Value must be one or more of the following flags.

Value Meaning
BCSS_ALIGNLEFT
 Align the image or glyph horizontally with the left margin.
BCSS_IMAGE
 Draw an icon image as the glyph.
BCSS_NOSPLIT
 No split.
BCSS_STRETCH
 Stretch glyph, but try to retain aspect ratio.

size

Type: SIZE

A SIZE structure that specifies the size of the glyph in himlGlyph.

Remarks

The glyph is the image that appears on the part of the button that activates the dropdown list. By default, this is an inverted triangle. Multiple images can be added to the image list to provide different glyphs for different states of the button, such as hot and pressed.

Requirements

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

See also

Buttons Overview