Handling an Image control by programming

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | Français

Help

Editors

Controls (window/page/report)

Controls

Image control

Handling an Image control by programming

Overview

Displaying an image file in an Image control

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

Retrieving the position of the mouse in a clickable image

Clearing or reinitializing the content of an Image control

Properties specific to the Image controls

See also

The Image control

Handling an Image control by programming

Overview

WINDEV, WEBDEV and WINDEV Mobile allow you to handle an Image control by 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.

Some examples:

direct assignment:

IMG_MyImage = "C:\Temp\MyImage.gif"
assignment by variable:

ImagePath = fCurrentDir() + "\MyImage.gif"
IMG_MyImage = ImagePath

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

Note: if the control is associated with a file item, the assignment is automatically performed by using FileToScreen. See Linking an Image control to an item for more details.

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>

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

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, fFileName + fExtension)
use ..Value

Note: 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 value typed is automatically retrieved by using 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.
See Linking an Image control to an item for more details.

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 ..Value.
use ..Caption (server code only).

In server code, these syntaxes are used to retrieve the image name defined in the "General" tab of control.

Example: ./background.gif

Note: 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 value typed is automatically retrieved by using 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.
See Linking an Image control to an item for more details.

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 = ""

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

Properties specific to the Image controls

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


Animation	Used to find out the current status of the animated image or to stop the animation of an animated image (animated GIF image for example)
InitialAnimation	Used to find out the initial status of the animation in an Image control
HorizontalAlignment	Used to find out and modify the horizontal alignment of the image caption
VerticalAlignment	Used to find out and modify the vertical alignment of the image caption
ImageMode	Used to find out and modify the display mode of an image in an Image control.

To find out the entire list of WLanguage properties that can be used with an Image control, see Properties associated with an Image control.