LabelPictureH Property, SftTree Object


	SftTree.LabelPictureH Property	Softel vdm, Inc.

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

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

Syntax

Get
	VB.NET	Handle = object.get_LabelPictureH(ByVal ItemIndex As Integer) As Integer
	VB	Handle = object.LabelPictureH(ByVal ItemIndex As Long) As OLE_HANDLE
	C#.NET	int Handle = object.get_LabelPictureH(int ItemIndex);
	VC++	OLE_HANDLE Handle = object->LabelPictureH[long ItemIndex]; OLE_HANDLE Handle = object->GetLabelPictureH(long ItemIndex);
	C	HRESULT object->get_LabelPictureH(long ItemIndex, OLE_HANDLE* Handle);
	Delphi	Handle := object.LabelPictureH[ItemIndex : Integer] : Cardinal;
Put
	VB.NET	object.set_LabelPictureH(ByVal ItemIndex As Integer, ByVal Handle As Integer)
	VB	object.LabelPictureH(ByVal ItemIndex As Long) = Handle As OLE_HANDLE
	C#.NET	void object.set_LabelPictureH(int ItemIndex, int Handle);
	VC++	OLE_HANDLE object->LabelPictureH[long ItemIndex] = Handle; void object->PutLabelPictureH(long ItemIndex, OLE_HANDLE Handle);
	C	HRESULT object->put_LabelPictureH(long ItemIndex, OLE_HANDLE Handle);
	Delphi	object.LabelPictureH[ItemIndex : Integer] := Handle : Cardinal;

object

A SftTree object.

ItemIndex

The zero-based item index.

Handle

A bitmap handle. Defines the graphic displayed as an item's label 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.LabelImage.PictureH instead

The LabelPictureH property defines the graphic displayed as an item's label graphic.

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

When using fixed height items (see Items.Style), all graphics used in a tree control as LabelPictureH property 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 all items, so graphics used as LabelPicture property are never clipped vertically. To change the label graphic size, all label graphics must be removed first using the Items.ClearLabelImages 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.

The Items.ClearLabelImages method can be used to remove all label graphics. The LabelPictureH property can be set to the value 0 (NULL), which removes the graphic from the item.

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