SftTree/DLL 7.5 - Tree Control

Bitmaps

Registers the size and sets the default item pictures used for all items.

C

BOOL WINAPI SftTree_SetBitmaps(HWND hwndCtl, HBITMAP *lphBitmap);
BOOL WINAPI SftTreeSplit_SetBitmaps(HWND hwndCtl, HBITMAP *lphBitmap);

C++

BOOL CSftTree::SetBitmaps(int val = 0);
BOOL CSftTree::SetBitmaps(const CBitmap Bitmap[3]);
BOOL CSftTreeSplit::SetBitmaps(int val = 0);
BOOL CSftTreeSplit::SetBitmaps(const CBitmap Bitmap[3]);

Parameters

hwndCtl

The window handle of the tree control.

lphBitmap, Bitmap

Three bitmaps to be used as default item pictures. In a fixed height tree control, all item pictures must be the same size. These three bitmaps are used as default item pictures for 1) an expandable parent item, 2) an expanded parent item and 3) a leaf item. The top, left pixel of each bitmap must contain the picture's background color. This color will be replaced by the actual window background color when the bitmap is displayed. This parameter may be NULL or omitted to stop displaying item pictures.

val

The only allowable value is 0, which is used to stop displaying item pictures.

Returns

The return value is TRUE if the function was successful, otherwise FALSE.

Comments

The SetBitmaps function registers the size and sets the default item pictures used for all items. There are no default item pictures.

SetBitmaps can be used to define default item pictures using bitmap handles only. SetPictures can be used to define default item pictures using additional picture types such as icons or ImageList images.

In a fixed height tree control, all item pictures used for all items must be the same size. New images can be registered at any time, but all item pictures in use must be replaced by images of the new size.

In a variable height tree control, item pictures can be of varying sizes. The largest picture size must be registered using SetBitmaps or SetPictures. Item pictures defined using SetItemPicture must be of equal or smaller size.

Individual item pictures can be set using SetItemPicture, but will not be shown unless default pictures have been registered using SetBitmaps or SetPictures. The height of all tree items is adjusted automatically to allow the complete picture to be displayed. The default pictures can be changed even after items have been added to the tree control. Items without individual item bitmap will immediately use the new default bitmaps.

The application retains ownership of the bitmaps and cannot delete these until the tree control no longer uses the bitmaps (usually until the tree control is destroyed or the bitmaps are changed using SetBitmaps or SetPictures).

An individual item's item picture can be defined using SetItemPicture.

See Also C/C++ API | Categories | Notifications