ItemPictureLeaf Property, SftTree Object


	SftTree.ItemPictureLeaf Property	Softel vdm, Inc.

Defines the default graphic used to display a leaf item's item graphic.

Deprecated - Provided for compatibility with earlier versions only - Use Items.ItemImageLeaf.Picture instead

Syntax

Get
	VB.NET	refPictureObj = object.ItemPictureLeaf As System.Drawing.Image
	VB	Set refPictureObj = object.ItemPictureLeaf As IPictureDisp
	C#.NET	System.Drawing.Image refPictureObj = object.ItemPictureLeaf;
	VC++	IPictureDisp* refPictureObj = object->GetItemPictureLeaf();
	C	HRESULT object->get_ItemPictureLeaf(IPictureDisp** refPictureObj);
	Delphi	refPictureObj := object.ItemPictureLeaf : TPicture;
Put
	VB.NET	object.let_ItemPictureLeaf(ByVal refPictureObj As System.Drawing.Image)
	VB	object.ItemPictureLeaf = refPictureObj As IPictureDisp
	C#.NET	void object.let_ItemPictureLeaf(System.Drawing.Image refPictureObj);
	VC++	void object->PutItemPictureLeaf(IPictureDisp* refPictureObj);
	C	HRESULT object->put_ItemPictureLeaf(IPictureDisp* refPictureObj);
	Delphi	procedure object._Set_ItemPictureLeaf(refPictureObj : TPicture);
PutRef
	VB.NET	object.ItemPictureLeaf = refPictureObj As System.Drawing.Image
	VB	Set object.ItemPictureLeaf = refPictureObj As IPictureDisp
	C#.NET	System.Drawing.Image object.ItemPictureLeaf = refPictureObj;
	VC++	void object->PutRefItemPictureLeaf(IPictureDisp* refPictureObj);
	C	HRESULT object->putref_ItemPictureLeaf(IPictureDisp* refPictureObj);
	Delphi	object.ItemPictureLeaf := refPictureObj : TPicture;

object

A SftTree object.

refPictureObj

Defines the default graphic used to display a leaf item's item graphic. The refPictureObj 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 Items.ItemImageLeaf.Picture instead

The ItemPictureLeaf property defines the default graphic used to display a leaf item's item graphic.

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

The ItemPictureLeaf property is used to define the default item graphic displayed for an item which doesn't have any dependents. Item graphics are not shown until the properties Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf define valid graphics.

When using fixed height items (see Items.Style), all graphics used in a tree control as Item.Image, 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 item graphics 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 ItemPictureLeaf property can be set to the value Nothing (NULL). Item graphics are then no longer displayed. The Item.Image properties remain unchanged.

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.

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.