BackgroundImageVectorHeight (ImageKit Control/ Custom Property)

When a vector image is being displayed as the background image in the ImageKit Control, this property sets the height of that vector image.

Property Value

The height, in pixels, of the vector image that is being displayed as the background image in the ImageKit Control. (default is 0).

Explanation

The BackgroundImageVectorHeight property sets the height of the vector image that is being displayed in the ImageKit Control as the background image.

If a DXF or SXF image is set in the BackgroundImageFile property:
If 0 or less is set in the either the BackgroundImageVectorHeight property or the BackgroundImageVectorWidth property, then the background image will have a height of 600 and a width of 800.

If an EMF, SVG, or WMF image is set in the BackgroundImageFile property:
If 0 or less is set in the either the BackgroundImageVectorHeight property or the BackgroundImageVectorWidth property, then the background image size will be determined by the height and width values stored in the image file.

Note: The actual display size will be the largest size possible to fit within the rectangle specified while maintaining the original height/width ratio.
The BackgroundImageVectorHeight property value and the BackgroundImageVectorWidth property value must be set prior to the BackgroundImageFile property.

Example Code

In Visual Basic:
'set the background image
ImageKit1.BarkgroundImageVectorWidth = 640 ImageKit1.BarkgroundImageVectorHeight = 480 ImageKit1.BackgroundImageFile = "C:\BackImage.emf"
'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.