Share via


CButton::SetBitmap

 

Call this member function to associate a new bitmap with the button.

Syntax

      HBITMAP SetBitmap(
   HBITMAP hBitmap 
);

Parameters

  • hBitmap
    The handle of a bitmap.

Return Value

The handle of a bitmap previously associated with the button.

Remarks

The bitmap will be automatically placed on the face of the button, centered by default. If the bitmap is too large for the button, it will be clipped on either side. You can choose other alignment options, including the following:

  • BS_TOP

  • BS_LEFT

  • BS_RIGHT

  • BS_CENTER

  • BS_BOTTOM

  • BS_VCENTER

Unlike CBitmapButton, which uses four bitmaps per button, SetBitmap uses only one bitmap per the button. When the button is pressed, the bitmap appears to shift down and to the right.

You are responsible for releasing the bitmap when you are done with it.

Example

CButton myBitmapButton;

// Create a bitmap button.
myBitmapButton.Create(_T("My button"), WS_CHILD|WS_VISIBLE|BS_BITMAP, 
   CRect(10,10,60,50), pParentWnd, 1);

// If no bitmap is defined for the button, define the bitmap to the
// system close bitmap.
if (myBitmapButton.GetBitmap() == NULL)
   myBitmapButton.SetBitmap(::LoadBitmap(NULL, MAKEINTRESOURCE(OBM_CLOSE)));

Requirements

Header: afxwin.h

See Also

CButton Class
Hierarchy Chart
CButton::GetBitmap
CBitmapButton Class
CBitmapButton::LoadBitmaps
Bitmaps