BackgroundImage (Property)

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

Versions 15 and later

This property is now available for Android applications.

New in version 15

This property is now available for Android applications.

Versions 17 and later

This property is now available for iPhone/iPad applications.

New in version 17

This property is now available for iPhone/iPad applications.

Versions 18 and later

This property is now available in Windows Store apps mode.

New in version 18

This property is now available in Windows Store apps mode.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

Versions 22 and later

This property is now available in browser code.

This property is now available for WEBDEV sites.

This property is now available for PHP sites.

New in version 22

This property is now available in browser code.

This property is now available for WEBDEV sites.

This property is now available for PHP sites.

This property is now available in browser code.

This property is now available for WEBDEV sites.

This property is now available for PHP sites.

Example

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

Versions 20 and later

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

New in version 20

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.
Versions 20 and later
The background image of a report.
New in version 20
The background image of a report.
The background image of a report.
Versions 21 and later
The background image of a Shape control.
New in version 21
The background image of a Shape control.
The background image of a Shape control.
Versions 21 and later
The background image of a Repositionable Note control.
New in version 21
The background image of a Repositionable Note control.
The background image of a Repositionable Note control.
Versions 22 and later
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
New in version 22
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
Versions 22 and later
The background image of dashboard Widgets.
New in version 22
The background image of dashboard Widgets.
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.
Versions 20 and later
The background image of a report.
New in version 20
The background image of a report.
The background image of a report.
Versions 21 and later
The background image of a Shape control.
New in version 21
The background image of a Shape control.
The background image of a Shape control.
Versions 21 and later
The background image of a Repositionable Note control.
New in version 21
The background image of a Repositionable Note control.
The background image of a Repositionable Note control.
Versions 22 and later
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
New in version 22
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
The background image of pages, iFrames, Cells, Supercontrols, Control templates, Menu option, Popup control.
Versions 22 and later
The background image of dashboard Widgets.
New in version 22
The background image of dashboard Widgets.
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.

Versions 20 and later

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 from the next page skip.

In a report other than form:

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

Remark: 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.

New in version 20

Modifying the background image in a report

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 from the next page skip.

In a report other than form:

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

Modifying the background image in a report

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 from the next page skip.

In a report other than form:

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

Limits

In a window, the BackgroundImage property only applies to:

windows,
buttons,
progress bars,
sliders,
Versions 20 and later
reports.
New in version 20
reports.
reports.
Versions 21 and later
Shape controls in a window.
New in version 21
Shape controls in a window.
Shape controls in a window.
Versions 21 and later
Repositionable Note controls in a window.
New in version 21
Repositionable Note controls in a window.
Repositionable Note controls in a window.

The BackgroundImage property only applies to the following elements:

Button.
Window.

Versions 22 and later

In a page, the BackgroundImage property only applies to:

Pages,
iFrames,
Cells,
Supercontrols,
Control templates,
Menu option,
Popup control,
Versions 20 and later
Reports.
New in version 20
Reports.
Reports.
Dashboard widget.

New in version 22

In a page, the BackgroundImage property only applies to:

Pages,
iFrames,
Cells,
Supercontrols,
Control templates,
Menu option,
Popup control,
Versions 20 and later
Reports.
New in version 20
Reports.
Reports.
Dashboard widget.

In a page, the BackgroundImage property only applies to:

Pages,
iFrames,
Cells,
Supercontrols,
Control templates,
Menu option,
Popup control,
Versions 20 and later
Reports.
New in version 20
Reports.
Reports.
Dashboard widget.