Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Overridable Property BackgroundImage As Picture | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As ElementWindowless Dim value As Picture instance.BackgroundImage = value value = instance.BackgroundImage | |
| C# | |
|---|---|
public virtual Picture BackgroundImage {get; set;} | |
Property Value
Picture object containing the imageRemarks
Elements can display pictures in layers. The first layer consists of a foreground picture, next comes the content of the element, such as text and a picture, then comes the background picture, and finally, the background of the element, which displays the background color.
Set this property to specify the background picture layer. This property is available at run time only.
Set the ForegroundImage property to specify the foreground picture layer. Set the Picture property to specify the picture in the content layer.
Set other features for the background picture using the following Picture class properties:
- AlignHorz
- Specifies horizontal alignment
- AlignVert
- Specifies vertical alignment
- Image
- Specifies the picture to display
- Style
- Specifies how to display the picture, such as stretched proportionally or tiled
- TransparencyColor
- Specifies what color in the picture to make transparent
If the application changes the background picture, the BackgroundImageChanged event occurs.
Example
| csharp | Copy Code |
|---|---|
control.BackgroundImage = new FarPoint.Win.Picture(Image.FromFile("d:\overlay.bmp")); control.MarginTop = 3; control.MarginBottom = 3; | |
| Visual Basic | Copy Code |
|---|---|
control.BackgroundImage = New FarPoint.Win.Picture(Image.FromFile("d:\overlay.bmp")) control.MarginTop = 3 control.MarginBottom = 3 | |
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2