Image (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Image associated with a report control or block
Image scanned in a report
Image in a menu option
Image of a tab or tab pane
Images of checkmarks in the check boxes and radio buttons
Image of icon displayed in the Action Bar
Limits

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Image (Property)

In french: Image

The Image property gets and sets the background image associated with an element.

In a report, the Image property gets and sets the background image of a control or block.

In a window, the Image property gets and sets the image:

displayed in the icon bar of an MDI parent window (WINDEV only),
associated with the caption of a button,
associated with a tab pane or with a tab,
associated with the toolbar panes or with the button of a toolbar pane,
associated with the caption of a menu option,
used as cursor in a progress bar or in a slider (except round sliders),
used as checkmark for check boxes and radio buttons (WINDEV only),
used in the options of check boxes and radio buttons in Vista style,
used in background image of a Calendar control.
used in a Rating control.
used for the markers of a Map control.
used in icon in an Action Bar (property available from Android version 4.0 (Ice cream sandwich, API level 14)).
used for a grouping when the grouping of a ribbon is closed.
used to represent an infinite progress bar.

In a page, the Image property gets and sets the image associated with:

an Image control,
a Web Camera control (server code only),
a fixed-image button (browser code only),
a Thumbnail control,
a Calendar control (background image).
a Social Network control (whose image is customized).
the markers of a Map control.

Remark: These images are defined in the editor in the description of the control, window or page ("General" or "Details" tab).

Example

// Modify the image associated with the caption of the "Help" button
BTN_Help.Image = "C:\MyImages\Help.ICO"

// Modify the image associated with a check box
CBOX_CheckBox.Image = "C:\MyImages\CheckBox_anim.gif"

// Modify the background image of "CustomerName" control
CustomerName..Image ="C:\MyImages\Image.BMP"

Syntax

Finding out the background image associated with a report element Hide the details

<Result> = <Element used>.Image

<Result>: Character string

Name and full path of the background image associated with the specified object.

<Element used>: Name of control or block.

Name of the element (control or block) to use.

Modifying the background image associated with a report element Hide the details

<Element used>.Image = <New image>

<Element used>: Name of control or block.

Name of the element (control or block) to use.

<New image>: Character string

Name and full path of the new background image associated with the specified object. A UNC path can be used.

Finding out the image associated with a control or with a window Hide the details

<Current image> = <Element used>.Image

<Current image>: Character string

Name and path of the image:
displayed in the icon bar of an MDI parent window,
associated with a check box or with a radio button,
associated with the caption of a button,
associated with a tab pane or with a tab,
associated with the toolbar panes or with the pane button
associated with the caption of a menu option,
used as cursor in a progress bar or in a slider (except round sliders).
associated with the option of a Radio Button or Check Box control in Vista style.
used in background image of a Calendar control.
associated with a Rating control.
used for the markers of a Map control.
used in icon in an Action Bar.
associated with a closed grouping of a ribbon.
used to represent an infinite progress bar.

<Element used>: Control name or window name

Name of the element to be used.

Modifying the image associated with a control or with a window Hide the details

<Element used>.Image = <New image>

<Element used>: Control name or window name

Name of the element to be used.

<New image>: Character string

Name and path (full, relative or UNC) of the new image:
displayed in the icon bar of an MDI parent window,
associated with a check box or with a radio button,
associated with the caption of a button,
associated with a tab pane or with a tab,
associated with the toolbar panes or with the pane button
associated with the caption of a menu option,
used as cursor in a progress bar or in a slider (except round sliders).
associated with the option of a Radio Button or Check Box control in Vista style.
used in background image of a Calendar control.
associated with a Rating control.
used for the markers of a Map control.
used in icon in an Action Bar.
associated with a closed grouping of a ribbon.
used to represent an infinite progress bar.

Finding out the image associated with a page control Hide the details

<Current image> = <Control used>.Image

<Current image>: Character string

Name and path of the image.
In server code, the full image path is specified.
In browser code, the path of the image is specified in relation to the _WEB directory of the site (for example, http://localhost/REWALI7_WEB/AXP01020_4E97E1FF_FR.gif).

<Control used>: Control name

Name of the control to be used.

Modifying the image associated with a page control Hide the details

<Control used>.Image = <New image>

<Control used>: Control name

Name of the control to be used.

<New image>: Character string

Name and path (full, relative or UNC) of the new image:
Static image: Modification without effect
Dynamic image: path such as "image2.gif" (with "image2.gif" in the "_WEB\" subdirectory of the project)
Generated image: full path such as "c:\my image\image2.gif"

Remarks

Image associated with a report control or block

The image associated with an Image control can be known and/or modified in the report editor, in the "General" tab of the control description.
The background image of a control or block can be known and/or modified in the report editor, in the "Style" tab of the description window. All you have to do is select the "Background image" element.

Image scanned in a report

The Image property cannot be used to change the scanned image of a report. Indeed, the scanned image of a report is used to:

easily position the different controls in the report,
view the result in the print preview.

Image in a menu option

If an image is associated with a marked menu option, the image replaces the checkmark.

Image of a tab or tab pane

To modify the image of a tab (which means the image of the tab buttons), use the following code:

TAB_Tab.Image = "Example.jpg"

To change the image displayed in the tab button (next to the text), simply specify the index of the tab to be modified:

TAB_Tab[1].Image = "Example.jpg"

Images of checkmarks in the check boxes and radio buttons

The Image property changes the checkmark in check boxes and radio buttons. This property corresponds to the "Image of checkmarks" option found in the "Details" tab of the control description.

If the image of the checkmark must not be animated: the image used must contain the two or three states of the checkmark: Checked, Unchecked and Undefined if necessary.

If the image of the checkmark is animated, the image used must be an image in GIF format containing the following images for each main status (Checked, Unchecked and Undefined):

Checkmark enabled (no animation)
Checkmark pressed (animation)
Checkmark grayed (no animation)
Checkmark hovered (animation)

Example of image used for an animated checkmark:

1. Images for the checked status.

2. Images for the unchecked status.

3. Images for the undefined status.

Image of icon displayed in the Action Bar

The Image property changes the icon displayed in the Action Bar of the window. If the Image property corresponds to an empty string (""), the application icon will be used (default behavior).

Caution: this property is available from Android version 4.0 (Ice cream sandwich, API level 14). The Image property will have no effect if it is used with an earlier version.

Limits

In a report, the Image property cannot be used on:

a report.
a bar code.
a Check Box control.

Authorized image formats:

The following image formats can be displayed: all the formats described in fGraphicFilter.
The following image formats can be displayed: BMP, ICO, JPEG and GIF.

The Image property can only be used on:

an MDI window,
a button,
a tab or a tab pane,
a toolbar pane or a pane button,
a menu option,
a progress bar,
a slider (except round sliders),
a check box,
a radio button,
a Calendar control,
a Rating control.
a Map control marker.
an infinite Progress Bar control.

The Image property can only be used on:

an Image control.
a Web Camera control.
a Calendar control.
a Social Network control (whose image is customized).
a Map control marker.

The Image property can only be used on:

a fixed-image button.
an Image control.
a Map control marker.

The Image property applies only to the following elements:

Button.
Window.