Share via

LVBKIMAGE (Compact 2013)

  • Article

3/28/2014

This structure contains information about the background image of a list-view control. This structure is used for both setting and retrieving background image information.

Syntax

typedef struct tagLVBKIMAGE {
  ULONG ulFlags;
  HBITMAP hbm;
  LPTSTR pszImage;
  UINT cchImageMax;
  int xOffsetPercent;
  int yOffsetPercent;
} LVBKIMAGE, *LPLVBKIMAGE;

Members

  • ulFlags
    This member may be one or more of the following flags. You can use the LVBKIF_SOURCE_MASK value to mask all but the source flags. You can use the LVBKIF_STYLE_MASK value to mask all but the style flags.

    Value

    Description

    LVBKIF_FLAG_TILEOFFSET

    Use this flag to specify the coordinates of the first tile. This flag is valid only if the LVBKIF_STYLE_TILE flag is also specified. If this flag is not specified, the first tile begins at the upper-left corner of the client area. The xOffsetPercent and yOffsetPercent fields contain pixel, not percentage values, to specify the coordinates of the first tile.

    LVBKIF_SOURCE_HBITMAP

    This flag specifies a handle to the background bitmap.

    LVBKIF_SOURCE_NONE

    The list-view control has no background image.

    LVBKIF_SOURCE_URL

    This flag is not supported.

    LVBKIF_STYLE_NORMAL

    The background image is displayed normally.

    LVBKIF_STYLE_TILE

    The background image will be tiled to fill the entire background of the control.
  • hbm
    Handle to the bitmap.
  • pszImage
    Address of a NULL-terminated string that contains the URL of the background image. This member is only valid if the LVBKIF_SOURCE_URL flag is set in ulFlags. This member must be initialized to point to the buffer that contains or receives the text before sending the message.
  • cchImageMax
    Size of the buffer at the address in pszImage. If information is being sent to the control, this member is ignored.
  • xOffsetPercent
    Percentage of the control's client area that the image should be offset horizontally. For example, at zero (0) percent, the image will be displayed against the left edge of the control's client area. At 50 percent, the image will be displayed horizontally centered in the control's client area. At 100 percent, the image will be displayed against the right edge of the control's client area. This member is only valid when LVBKIF_STYLE_NORMAL is specified in ulFlags. If both LVBKIF_FLAG_TILEOFFSET and LVBKIF_STYLE_TILE are specified in ulFlags, then the value specifies the pixel, not percentage offset, of the first tile. Otherwise, the value is ignored.
  • yOffsetPercent
    Percentage of the control's client area that the image should be offset vertically. For example, at zero (0) percent, the image will be displayed against the top edge of the control's client area. At 50 percent, the image will be displayed vertically centered in the control's client area. At 100 percent, the image will be displayed against the bottom edge of the control's client area. This member is only valid when LVBKIF_STYLE_NORMAL is specified in ulFlags. If both LVBKIF_FLAG_TILEOFFSET and LVBKIF_STYLE_TILE are specified in ulFlags, then the value specifies the pixel, not percentage offset, of the first tile. Otherwise, the value is ignored.

Remarks

This structure is used with the LVM_GETBKIMAGE and LVM_SETBKIMAGE messages.

Requirements

Header

commctrl.h

See Also

Reference

List-View Controls Structures