Handling Image controls programmatically

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Image control

Overview
Displaying an image file in an Image control
In a window
In a page
Retrieving the name of the image file displayed in the Image control
In a window
In a page
Retrieving the position of the mouse in a clickable image
Clearing or reinitializing the content of an Image control
Properties specific to Image controls

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Handling Image controls programmatically

Overview

WINDEV, WEBDEV and WINDEV Mobile allow you to handle an Image control through programming. To do so, use the variable of the Image control in the code.

The variable of Image control corresponds to the name of Image control. This variable is a text variable.

Displaying an image file in an Image control

In a window

To display an image file in an Image control, a simple assignment is sufficient.

For example:

direct assignment:
IMG_MyImage = "C:\Temp\MyImage.gif"
assignment using a variable:
ImagePath = fCurrentDir() + "\MyImage.gif"
IMG_MyImage = ImagePath

Remark: An Image control can also be initialized from a buffer variable or from a text variable containing the image value in binary format.

Remark: if the control is associated with a data file item, values are assigned automatically via FileToScreen. For more details, see Linking an Image control to an item.

In a page

To display an image file in an Image control, a simple assignment is sufficient.

If the image is available in the "<ProjectName>_WEB", directory, you have the ability to use the following syntaxes:

Server code:
<Image control> = <Image name>

Remark: In server code, if the image is available in a directory other than "<ProjectName>_WEB", you must:
- specify the full path of image.
- have read rights in this directory.
Browser code:
<Image control> = FolderWeb() + <Image name>

Remark: In the "Details" tab of the Image control description window, you can define the type of assignment in browser code for compatibility. If this option corresponds to "Path in _WEB directory", FolderWeb has no effect. The following syntax can be used:
<Image control> = <Image name>

Remark: If the control is bound to a data file item, the value from the data source is automatically updated in the control using FileToPage. For more details, see Linking an Image control to an item.

Retrieving the name of the image file displayed in the Image control

In a window

To retrieve the name of the image displayed in an Image control:

perform a simple assignment. For example:
EDT_CurrentImageContent = IMG_Image1
retrieve part of the name, with fExtractPath. For example:
NameImageFile = fExtractPath(IMG_Image1, fFile + fExtension)
use the Value property

Remark: To retrieve the image (or its name) in the item associated with the Image control:

If the control is associated with a text item, the entered value is automatically retrieved via ScreenToFile. You also have the ability to use the following notation: CUSTOMER.NAME = EDT_Edit1.
If the control is associated with a binary memo, use HLinkMemo to associate the image file with the item.
If the Image control was assigned from a buffer variable or from a string variable, Value returns an empty string.
For more details, see Linking an Image control to an item.

In a page

To retrieve the name of the image displayed in an Image control:

perform a simple assignment. For example:
EDT_CurrentImageContent = IMG_Image1
use the Value property.
use the Caption property (server code only).

In server code, these syntaxes are used to get the name of the image defined in the "General" tab of the control. Example: ./background.gif

In browser code, these syntaxes are used to retrieve the full image name on the server.

Example: http://localhost/addressbook_Web/background_fr.gif

Remark: To retrieve the image (or its name) in the item associated with the Image control,

If the control is associated with a text item, the entered value is automatically retrieved via PageToFile. You also have the ability to use the following notation: CUSTOMER.NAME = EDT_Edit1.
If the control is associated with a binary memo, use HLinkMemo to associate the image file with the item.
For more details, see Linking an Image control to an item.

Retrieving the position of the mouse in a clickable image

To retrieve the position of the mouse in a click area, the following functions must be used in the click code of the image:


MouseXPos	Returns the horizontal coordinate of the mouse click.
MouseYPos	Returns the vertical coordinate of the mouse click.

Clearing or reinitializing the content of an Image control

To clear or reinitialize an Image control, all you have to do is assign an empty string to the Image control. For example:

IMG_MyImage = ""

Remark: You also have the ability to use dStartDrawing/dEndDrawing on the Image control.

Properties specific to Image controls

The following properties are used to manage the characteristics of an Image control by programming.


Animation	Gets the current status of the animated image or starts/stops the animation of an image (e.g., animated GIF).
HorizontalAlignment	Gets and sets the horizontal alignment of the image caption.
ImageMode	Used to find out and modify the display mode of an image in an Image control.
InitialAnimation	Used to find out the initial status of the animation in an Image control.
VerticalAlignment	Gets and sets the vertical alignment of the image caption.

For a complete list of WLanguage properties that can be used with Image controls, see Image control properties.