BackgroundImage (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage properties / Properties associated with windows, pages and controls

Modifying the image
Modifying the background image in a report
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

BackgroundImage (Property)

In french: ImageFond

The BackgroundImage property is used to identify and modify the background color of an element: window, page, control or report.

Remarks:

The background image of a window or a control is defined in the description window of the element ("General" or "Image" tab).
The background image of a report is defined in the report description("Background" tab).

Example

// Modify the background image of "WIN_EditCustomer"
WIN_EditCustomer.BackgroundImage = "C:\MyImages\Image.gif"

// Before printing Page_header
// Modify the background image of report
// Use a different page found in a PDF
MyReport.BackgroundImagePrinted = True
MyReport.BackgroundImage = PDFExtractPage("Form.pdf", 2)

Syntax

Finding out the background image of a control, window or report Hide the details

<Current image> = <Element used>.BackgroundImage

<Current image>: Character string

Name and path of background image. This background image can correspond to:
The background image associated with a window (except for the MDI parent windows).
The background image associated with the MDI area of an MDI parent window.
The image associated with the border of a button.
The background image associated with a progress bar or slider.
The background image of a report.
The background image of a Shape control.
The background image of a Repositionable Note control.
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
The background image of dashboard widgets.

<Element used>: Name of control, window, page or report

Name of element used.

Modifying the background image of a control, window or report Hide the details

<Element used>.BackgroundImage = <New image>

<Element used>: Name of control, window, page or report

Name of element used.

<New image>: Character string

Name and path (full, relative or UNC) of new background image. This image can correspond to:
The background image associated with a window (except for the MDI parent windows).
The background image associated with the MDI area of an MDI parent window.
The image associated with the border of a button.
The background image associated with a progress bar or slider.
The background image of a report.
The background image of a Shape control.
The background image of a Repositionable Note control.
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
The background image of dashboard widgets.

Remarks

Modifying the image

When changing the image, the image is sought in the application library (WDL file) then on disk at the specified location.

Remark: If an attempt is made to replace the image found in the WDL by an image with the same name found on disk, the change of image is not performed.

Modifying the background image in a report

The BackgroundImage property is available for all types of reports. The BackgroundImage property must be called before printing the page, for example in the event "Before printing the page header block".

For a report on form:

the BackgroundImage property replaces the background image chosen in edit mode. All types of images supported in the reports are available (PDF, SVG, JPG, PNG, etc.).
the image is saved by page: therefore, a different background image can be specified for each printed page.
when the property is assigned, the new background image will be printed starting from the next page break.

In a report other than a form:

the image is drawn in "homothetic" mode.
this property has an effect only in actual print jobs, in the report viewer and in PDF exports. It has no effect for the other types of export (RTF, XLS, HTML, XML).

Remarks:

The management of margins specified in the "Background" tab of the report description ("Ignore the physical margins of the printer") is ignored: the physical margins are systematically ignored.
The BackgroundImagePrinted property can be used to print the background image of the report. If this property is set to:
- False (default value), the print job can be done on pre-printed paper for example. The background image appears only in the report viewer.
- True, the background image is also printed (or exported to PDF).
Remark: You can also configure this behavior via the "Behavior in print jobs" option in the "Background" tab of the report description window.

Limitations

In a window, the BackgroundImage property applies only to:

windows,
buttons,
progress bars,
sliders,
reports.
Shape controls in a window.
Repositionable Note controls in a window.

The BackgroundImage property applies only to the following elements:

Button.
Window.

In a page, the BackgroundImage property only applies to:

Pages,
iFrames,
Cells,
Supercontrols,
Control templates,
Menu option,
Popup control,
Reports.
Dashboard widget.