WinBackgroundImage (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Window functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Window functions

WinBackgroundImage (Function)

In french: FenImageFond

Modifies the background image of a window and specifies the display mode of this image.

Example

// Modification de l'image de fond de la fenêtre "FEN_SaisieImage"
// La nouvelle image est "C:\Documents\Fond.GIF"
// Cette image sera centrée dans la fenêtre
Res = WinBackgroundImage(FEN_SaisieImage, "C:\Documents\Fond.GIF", imgCentered)

Syntax

<Result> = WinBackgroundImage(<Window used> , <Image name> , <Display>)

<Result>: Boolean

True if the background image was modified,
False otherwise.

<Window used>: Window name

Name of the window to be used.
If this parameter corresponds to an empty string (""), the current window is used.

<Image name>: Character string

Name and full (or relative) path of the image to display in the window. A UNC path can be used. No image is displayed in the window if this parameter does not correspond to an existing image.

<Display>: Constant

Indicates the display mode of the image:
imgCentered Centered: Image centered in the window.
imgH Homothetic: Image enlarged or reduced in size to match the proportions of the original image, so that it can be fully displayed in the window.
imgHC Homothetic centered: Image enlarged or reduced in size, respecting the proportions of the original image and centered in the window.
imgHCE Homothetic extended centered: Image enlarged or reduced in size, respecting the proportions of the original image, so that the smaller side of the image is displayed entirely in the window and centered in the window.
imgHCWIS Homothetic without centered enlargement: If the image can be displayed entirely in the window, it is displayed at 100% and centered in the window.. Otherwise, the image is proportionally reduced so that it can be entirely displayed and centered in the window.
imgHE Extended homothetic: Image enlarged or reduced in size, respecting the proportions of the original image, so that the smaller side of the image is displayed entirely in the window.
imgHWIS Homothetic without enlargement: If the image can be fully displayed in the window, it is displayed at 100%.. Otherwise, it is downsized, while maintaining its aspect ratio to fit the control.
imgNormal 100%: Image displayed at 100% in the top left-hand corner of the window.
imgStretched Stretched: Image distorted to occupy the entire window surface.
imgTiled RepeatString: Image displayed at 100% and repeated to occupy the entire window (mosaic).

Component: wd300obj.dll