ImageList_DrawEx

  • Article

This function draws an image list item in the specified device context (DC). ImageList_DrawEx uses the specified drawing style and blends the image with the specified color.

BOOL WINAPI ImageList_DrawEx(
HIMAGELIST himl, 
int i, 
HDC hdcDst, 
int x, 
int y, 
int dx, 
int dy, 
COLORREF rgbBk, 
COLORREF rgbFg, 
UINT fStyle );

Parameters

  • himl
    [in] Handle to the image list.

  • i
    [in] Index of the image to draw.

  • hdcDst
    [in] Handle to the destination device context.

  • x
    [in] Specifies the x-coordinate at which to draw within the specified device context.

  • y
    [in] Specifies the y-coordinate at which to draw within the specified device context.

  • dx
    [in] Specifies the width of the portion of the image to draw relative to the upper-left corner of the image. If dx and dy are zero, the function draws the entire image. The function does not ensure that the parameters are valid.

  • dy
    [in] Specifies the height of the portion of the image to draw, relative to the upper-left corner of the image. If dx and dy are zero, the function draws the entire image. The function does not ensure that the parameters are valid.

  • rgbBk
    [in] Background color of the image. This parameter can be an application-defined RGB value or one of the following values:

    Value Description
    CLR_NONE No background color. The image is drawn transparently.
    CLR_DEFAULT Default background color. The image is drawn using the background color of the image list.

    This parameter is used only if the image list identified by himl was created with the ILC_MASK value.

  • rgbFg
    [in] Foreground color of the image. This parameter can be an application-defined RGB value or one of the following values:

    Value Description
    CLR_NONE No blend color. The image is blended with the color of the destination device context.
    CLR_DEFAULT Default foreground color. The image is drawn using the system highlight color as the foreground color.

    This parameter is used only if fStyle includes the ILD_BLEND25 or ILD_BLEND50 value.

  • fStyle
    [in] Specifies the drawing style and, optionally, the overlay image. For information about specifying an overlay image index, see the comments section at the end of this topic. This parameter can be a combination of an overlay image index and one or more of the following values:

    Value Description
    ILD_BLEND25, ILD_FOCUS Draws the image, blending 25 percent with the blend color specified by rgbFG. This value has no effect if the image list does not contain a mask.
    ILD_BLEND50, ILD_SELECTED, ILD_BLEND Draws the image, blending 50 percent with the blend color specified by rgbFG. This value has no effect if the image list does not contain a mask.
    ILD_MASK Draws the mask.
    ILD_NORMAL Draws the image using the background color for the image list. If the background color is the CLR_NONE value, the image is drawn transparently using the mask.
    ILD_TRANSPARENT Draws the image transparently using the mask, regardless of the background color. This value has no effect if the image list does not contain a mask.

Return Values

Nonzero indicates success. Zero indicates failure.

Remarks

An overlay image is drawn transparently over the primary image specified in the i parameter. To specify an overlay image in the fStyle parameter, use the INDEXTOOVERLAYMASK macro to shift the one-based index of the overlay image. Use the OR operator to logically combine the return value of the macro with the drawing style flags specified in the fStyle parameter. You must first specify this image as an overlay image by using the ImageList_SetOverlayImage function.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Commctrl.h   Commctrl.lib, Imgctl.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

ImageList_Draw, ImageList_SetOverlayImage, INDEXTOOVERLAYMASK, COLORREF

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.