ItemPictureH Property, SftTree Object


	SftTree.ItemPictureH Property	Softel vdm, Inc.

Defines the graphic displayed as the item's item graphic.

Deprecated - Provided for compatibility with earlier versions only - Use Item.Image.PictureH instead

Syntax

Get
	VB.NET	Handle = object.get_ItemPictureH(ByVal ItemIndex As Integer) As Integer
	VB	Handle = object.ItemPictureH(ByVal ItemIndex As Long) As OLE_HANDLE
	C#.NET	int Handle = object.get_ItemPictureH(int ItemIndex);
	VC++	OLE_HANDLE Handle = object->ItemPictureH[long ItemIndex]; OLE_HANDLE Handle = object->GetItemPictureH(long ItemIndex);
	C	HRESULT object->get_ItemPictureH(long ItemIndex, OLE_HANDLE* Handle);
	Delphi	Handle := object.ItemPictureH[ItemIndex : Integer] : Cardinal;
Put
	VB.NET	object.set_ItemPictureH(ByVal ItemIndex As Integer, ByVal Handle As Integer)
	VB	object.ItemPictureH(ByVal ItemIndex As Long) = Handle As OLE_HANDLE
	C#.NET	void object.set_ItemPictureH(int ItemIndex, int Handle);
	VC++	OLE_HANDLE object->ItemPictureH[long ItemIndex] = Handle; void object->PutItemPictureH(long ItemIndex, OLE_HANDLE Handle);
	C	HRESULT object->put_ItemPictureH(long ItemIndex, OLE_HANDLE Handle);
	Delphi	object.ItemPictureH[ItemIndex : Integer] := Handle : Cardinal;

object

A SftTree object.

ItemIndex

The zero-based item index.

Handle

A bitmap handle. Defines the graphic displayed as the item's item graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. The top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Item.Image.PictureH instead

The ItemPictureH property defines the graphic displayed as the item's item graphic.

The ItemPicture and ItemPictureH properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).

The ItemPictureH property is used to override the default item graphic defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties. These default graphics must be defined for item graphics to be shown.

The ItemPictureH property can be set before the default graphics have been defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties, but item graphics are not shown until these default graphics are defined.

When using fixed height items (see Items.Style), all graphics used in a tree control as ItemPicture, Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as ItemPicture property are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.ClearItemImages method.

When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.

If an item is disabled (see Item.Enabled property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.

The ItemPictureH property can be set to the value 0 (NULL), which restores the default graphic.

The Items.ItemImageAlign property can be used to align item graphics on lower levels with higher level cells.

The VAlignStyle property can be used to define the vertical alignment of item graphics.