SftBox/OCX 4.5

SftBoxHeader.Image Property

Softel vdm, Inc.

Defines the graphic displayed in this column header.

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 SftBoxHeader object.

refImageObj

Defines the graphic displayed in this column header.

Comments

The Image property defines the graphic displayed in this column header.

All column header 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 column headers (and row/column header), so graphics and text are never clipped vertically. To change the size of all header graphics used, they must be removed first using the Headers.ClearImages method.

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).

To remove an individual header picture, set the property to Nothing (0, null, NULL).

The position of the graphic relative to the text component can be defined using the Header.ImageHAlign and Header.ImageVAlign properties.


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