SftBox/OCX 4.5

SftBoxItem.Image Property

Softel vdm, Inc.

Defines the item graphic displayed in this item.

Syntax       

Get

VB.NET

refImageObj = object.Image  As SftPictureObject

VB

Set refImageObj = object.Image  As SftPictureObject

C#.NET

SftPictureObject refImageObj = object.Image;

VC++

ISftPictureObject* refImageObj = object->Image;
ISftPictureObject* refImageObj = object->GetImage();

C

HRESULT object->get_Image(ISftPictureObject** refImageObj);

Delphi

refImageObj := object.Image  : ISftPictureObject;

Put

VB.NET

object.Image = refImageObj  As SftPictureObject

VB

object.Image = refImageObj  As SftPictureObject

C#.NET

SftPictureObject object.Image = refImageObj;

VC++

ISftPictureObject* object->Image = refImageObj;
void object->PutImage(ISftPictureObject* refImageObj);

C

HRESULT object->put_Image(ISftPictureObject* refImageObj);

Delphi

object.Image := refImageObj  : ISftPictureObject;

object

A SftBoxItem object.

refImageObj

Defines the item graphic displayed in this item.

Comments

The Image property defines the item graphic displayed in this item.

The Item.Image property is used to override the default item graphic defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties.

In a fixed height combo box control, all item picture graphics (i.e. all bitmaps) must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum required height for all items, so graphics and text are never clipped vertically. To change the size of all item graphics used, they must be removed first using the Items.ClearItemImages method.

In a variable height combo box control, the graphics can be of varying sizes. The item height is automatically adjusted so graphics are never clipped vertically.

To remove an individual item picture, set the property to Nothing (0, null, NULL). If the default item graphics Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf have been defined, this restores the default picture.

If the image object refImageObj defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see Bitmap Transparency).

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


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com