BackgroundImageFile (ImageKit Control/ Custom Property)

This property sets the name of the file displayed as the background image in the ImageKit Control

[Visual Basic] imagekitcontrolname.BackgroundImageFile [= String ]

[Visual C++] [long = ]imagekitcontrolname.GetBackgroundImageFile()
imagekitcontrolname.SetBackgroundImageFile(LPCTSTR Val)

Property Value

The name of the file that is displayed as the background image in the ImageKit Control.

Explanation

The BackgroundImageFile property sets the name of the file displayed as the background image in the ImageKit Control. This property is enabled with the Transparent property is True.

Rules for using a background image:

The background image will be displayed under a base image
If the background image is larger than the base image, the background image will be resized to the dimensions of the base image.

Example Code

In Visual Basic:
'set the background image
ImageKit1.BackgroundImageFile = "C:\BackImage.bmp"
'set the transparent color in the base image to white
ImageKit1.TransBlue = 255
ImageKit1.TransGreen = 255
ImageKit1.TransRed = 255
ImageKit1.Transparent = True

Setting this value

This value can be set at run-time.

Retrieving this value

This value can be retrieved at run-time.