RowPicture Property, SftTree Object


	SftTree.RowPicture Property	Softel vdm, Inc.

Defines the graphic displayed in an item's row header.

Deprecated - Provided for compatibility with earlier versions only - Use RowHeader.Image.Picture instead

Syntax

Get
	VB.NET	refPictureObj = object.get_RowPicture(ByVal ItemIndex As Integer) As System.Drawing.Image
	VB	Set refPictureObj = object.RowPicture(ByVal ItemIndex As Long) As IPictureDisp
	C#.NET	System.Drawing.Image refPictureObj = object.get_RowPicture(int ItemIndex);
	VC++	IPictureDisp* refPictureObj = object->GetRowPicture(long ItemIndex);
	C	HRESULT object->get_RowPicture(long ItemIndex, IPictureDisp** refPictureObj);
	Delphi	refPictureObj := object.RowPicture[ItemIndex : Integer] : TPicture;
Put
	VB.NET	object.let_RowPicture(ByVal ItemIndex As Integer, ByVal refPictureObj As System.Drawing.Image)
	VB	object.RowPicture(ByVal ItemIndex As Long) = refPictureObj As IPictureDisp
	C#.NET	void object.let_RowPicture(int ItemIndex, System.Drawing.Image refPictureObj);
	VC++	void object->PutRowPicture(long ItemIndex, IPictureDisp* refPictureObj);
	C	HRESULT object->put_RowPicture(long ItemIndex, IPictureDisp* refPictureObj);
	Delphi	procedure object._Set_RowPicture(ItemIndex : Integer, refPictureObj : TPicture);
PutRef
	VB.NET	object.set_RowPicture(ByVal ItemIndex As Integer, ByVal refPictureObj As System.Drawing.Image)
	VB	Set object.RowPicture(ByVal ItemIndex As Long) = refPictureObj As IPictureDisp
	C#.NET	void object.set_RowPicture(int ItemIndex, System.Drawing.Image refPictureObj);
	VC++	void object->PutRefRowPicture(long ItemIndex, IPictureDisp* refPictureObj);
	C	HRESULT object->putref_RowPicture(long ItemIndex, IPictureDisp* refPictureObj);
	Delphi	object.RowPicture[ItemIndex : Integer] := refPictureObj : TPicture;

object

A SftTree object.

ItemIndex

The zero-based item index.

refPictureObj

Defines the graphic displayed in the item's row header. 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 RowHeader.Image.Picture instead

The RowPicture property defines the graphic displayed in an item's row header.

The RowPicture and RowPictureH 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 RowPicture 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 the row headers, so graphics used as RowPicture property are never clipped vertically. To change the row header graphic size, all row header graphics must be removed first using the RowHeaders.ClearImages 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 row headers are disabled (see RowHeaders.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. Individual items may be disabled using the Item.Enabled property.

The RowHeaders.ClearImages method can be used to remove all row header graphics. The RowPicture property can be set to the value Nothing (NULL), which removes the graphic from the row header.

The position of the row header graphic is determined by the RowHeader.ImageHAlign and RowHeader.ImageVAlign properties.

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.