ButtonPicture Property, SftTree Object


	SftTree.ButtonPicture Property	Softel vdm, Inc.

Defines the graphic used to display expand/collapse buttons.

Deprecated - Provided for compatibility with earlier versions only - Use the ButtonAppearance property instead

Syntax

Get
	VB.NET	refPictureObj = object.ButtonPicture As System.Drawing.Image
	VB	Set refPictureObj = object.ButtonPicture As IPictureDisp
	C#.NET	System.Drawing.Image refPictureObj = object.ButtonPicture;
	VC++	IPictureDisp* refPictureObj = object->GetButtonPicture();
	C	HRESULT object->get_ButtonPicture(IPictureDisp** refPictureObj);
	Delphi	refPictureObj := object.ButtonPicture : TPicture;
Put
	VB.NET	object.let_ButtonPicture(ByVal refPictureObj As System.Drawing.Image)
	VB	object.ButtonPicture = refPictureObj As IPictureDisp
	C#.NET	void object.let_ButtonPicture(System.Drawing.Image refPictureObj);
	VC++	void object->PutButtonPicture(IPictureDisp* refPictureObj);
	C	HRESULT object->put_ButtonPicture(IPictureDisp* refPictureObj);
	Delphi	procedure object._Set_ButtonPicture(refPictureObj : TPicture);
PutRef
	VB.NET	object.ButtonPicture = refPictureObj As System.Drawing.Image
	VB	Set object.ButtonPicture = refPictureObj As IPictureDisp
	C#.NET	System.Drawing.Image object.ButtonPicture = refPictureObj;
	VC++	void object->PutRefButtonPicture(IPictureDisp* refPictureObj);
	C	HRESULT object->putref_ButtonPicture(IPictureDisp* refPictureObj);
	Delphi	object.ButtonPicture := refPictureObj : TPicture;

object

A SftTree object.

refPictureObj

A Picture object. This Picture object contains the graphic used to display the expand/collapse buttons. The refPictureObj object must represent a bitmap and cannot represent an icon or a metafile. For information about picture properties, please visit the applicable section "Using SftTree/OCX with ...".

Comments

Deprecated - Provided for compatibility with earlier versions only - Use the ButtonAppearance property instead

The ButtonPicture property defines the graphic used to display expand/collapse buttons.

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

The ButtonPicture property can be used to override the default expand/collapse buttons provided by a tree control. The refPictureObj object must represent a bitmap and cannot represent an icon or a metafile.

The bitmap represented by the refPictureObj object must contain four equal-sized images of an expand/collapse button in the following 4 states:

up, expandable item. The default is a 12 x 11 button with a '+' image.
up, expanded item. The default is a 12 x 11 button with a '-' image.
down, expandable item. The default is a 12 x 11 button with a '+' image.
down, expanded item. The default is a 12 x 11 button with a '-' image.

The buttons are arranged horizontally in the bitmap, so the height of the bitmap is the height of one button and the width of the bitmap is four times the width of one button. The top, left pixel of each button bitmap must contain the background color. This color will be replaced by the actual item background color when the bitmap is displayed.

All items use the same expand/collapse button graphic. Expand/collapse buttons are only shown if the ButtonStyle property is set accordingly. Only parent items with dependents receive an expand/collapse button. Leaf items never have an expand/collapse button.

The ButtonPicture property can be set to the value Nothing (NULL), which restores the tree control's default, built-in expand/collapse button bitmap.

The ButtonStyle property can be used to define the presence of expand/collapse buttons.

The height of the items displayed is adjusted if necessary so the complete button graphic can be displayed vertically and horizontally.

Sample button bitmaps can be found in the directory \Program Files\Softelvdm\SftTree OCX 6.0\Images. E.g., Buttons4.bmp contains the button image as used by Windows Explorer.

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.