LabelPicture Property, SftTree Object


	SftTree.LabelPicture 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.Picture instead

Syntax

Get
	VB.NET	refPictureObj = object.get_LabelPicture(ByVal ItemIndex As Integer) As System.Drawing.Image
	VB	Set refPictureObj = object.LabelPicture(ByVal ItemIndex As Long) As IPictureDisp
	C#.NET	System.Drawing.Image refPictureObj = object.get_LabelPicture(int ItemIndex);
	VC++	IPictureDisp* refPictureObj = object->GetLabelPicture(long ItemIndex);
	C	HRESULT object->get_LabelPicture(long ItemIndex, IPictureDisp** refPictureObj);
	Delphi	refPictureObj := object.LabelPicture[ItemIndex : Integer] : TPicture;
Put
	VB.NET	object.let_LabelPicture(ByVal ItemIndex As Integer, ByVal refPictureObj As System.Drawing.Image)
	VB	object.LabelPicture(ByVal ItemIndex As Long) = refPictureObj As IPictureDisp
	C#.NET	void object.let_LabelPicture(int ItemIndex, System.Drawing.Image refPictureObj);
	VC++	void object->PutLabelPicture(long ItemIndex, IPictureDisp* refPictureObj);
	C	HRESULT object->put_LabelPicture(long ItemIndex, IPictureDisp* refPictureObj);
	Delphi	procedure object._Set_LabelPicture(ItemIndex : Integer, refPictureObj : TPicture);
PutRef
	VB.NET	object.set_LabelPicture(ByVal ItemIndex As Integer, ByVal refPictureObj As System.Drawing.Image)
	VB	Set object.LabelPicture(ByVal ItemIndex As Long) = refPictureObj As IPictureDisp
	C#.NET	void object.set_LabelPicture(int ItemIndex, System.Drawing.Image refPictureObj);
	VC++	void object->PutRefLabelPicture(long ItemIndex, IPictureDisp* refPictureObj);
	C	HRESULT object->putref_LabelPicture(long ItemIndex, IPictureDisp* refPictureObj);
	Delphi	object.LabelPicture[ItemIndex : Integer] := refPictureObj : TPicture;

object

A SftTree object.

ItemIndex

The zero-based item index.

refPictureObj

Defines the graphic displayed as an item's label graphic. The Picture object must represent a bitmap, icon or Windows metafile. If a bitmap is used, 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. For information about picture properties, please visit the applicable section "Using SftTree/OCX with ...".

Comments

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

The LabelPicture 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 LabelPicture 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 LabelPicture property can be set to the value Nothing (NULL), which removes the graphic from the item.

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

Using PutRef (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using Put instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of Put, PutRef is the preferred method.