gImage (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Graphic string management functions

gImage

Presentation

Example

Inserting images

Image height (List Box or Combo Box control)

Image in the title of a column in a Table control

See also

gImage (Function)

In french: gImage

Builds a sequence of characters containing an image.

In a window, this sequence of characters is used to insert an image:

in an element of a List Box or Combo Box control.
in the title bar and/or status bar of a window.
in a Static control.
in a Text column found in a Table control.

The inserted image can be:

a standard image,
an image made of several drawings. This image will have been divided beforehand (by LoadImage or by LoadImageSheet).

Example

// Add the "C:\MyImages\Image.BMP" image to the "LIST_Customer" control
ListAdd(LIST_Customer, gImage("C:\MyImages\Image.BMP"))

// Add an image made of several drawings
// Split into 10 rows and 2 columns
// Load the "C:\MyImages\DecImage.BMP" image in memory
LoadImage(IDImage, "C:\MyImages\DecImage.BMP", 10, 2)
FOR DrawingRank = 1 TO 10*2
ListAdd(LIST_Customer, gImage(IDImage, DrawingRank))
END

// Add an image to the title of a column in a Table control
TABLE_MyTable.COL_MyColumn.Title = gImage("MyImage.BMP") + "My title"

Syntax

Inserting a standard image Hide the details

<Result> = gImage(<Image name>)

<Result>: Character string

Sequence of characters in the following format: <Image identifier>, <Drawing rank>.
This sequence of characters can be:
used in ListAdd, ListInsert or ListModify.
assigned to a Static control.
used in the title bar or status bar of a window.
used in a Text column found in a Table control.

<Image name>: Character string

Name and full (or relative) path of the image to insert. A UNC path can be used.
Name of Image control containing the image to insert.

Inserting an image made of several drawings Hide the details

<Result> = gImage(<Image identifier> , <Drawing rank>)

<Result>: Character string

Sequence of characters in the following format: <Image identifier>, <Drawing rank>.
This sequence of characters can be:
used in ListAdd, ListInsert or ListModify.
assigned to a Static control.
used in the title bar or status bar of a window.
used in a Text column found in a Table control.

<Image identifier>: Integer

Identifier of the image (between 1 and 9) corresponding to the identifier of the image divided and loaded in memory by LoadImage or LoadImageSheet.

<Drawing rank>: Integer

Number of the drawing cut. The set of drawings constitutes the image. This number ranges from 1 to the result of the multiplication of <Number of columns> and <Number of rows> used in LoadImage or LoadImageSheet.

Inserting an image contained in an Image variable Hide the details

<Result> = gImage(<Image> [, <Mode>])

<Result>: Character string

Sequence of characters in the following format: <Image identifier>, <Drawing rank>.
This sequence of characters can be:
used in ListAdd, ListInsert or ListModify.
assigned to a Static control.
used in the title bar or status bar of a window.
used in a Text column found in a Table control.

<Image>: Image variable

Name of the Image variable to insert.

<Mode>: Optional Integer constant

Image display mode:
imgCentered Centered: Image centered in the control.
imgHC Homothetic centered: Image enlarged or reduced (while respecting the proportions of initial image) to occupy the entire surface of control and centered in the control.
imgHCE Homothetic centered extended: Image enlarged or reduced (while respecting the proportions of the initial image) in order for the smaller side of the image to be entirely displayed in the control and in order for the image to be centered in the control.
imgHCWIS Homothetic without enlargement: If the image can be entirely displayed in the control, it is displayed at 100% and centered in the control. Otherwise, the image is proportionally reduced in order to be entirely displayed and centered in the control.
imgHE Homothetic extended: Image enlarged or reduced (while respecting the proportions of initial image) so that the smaller side of image is entirely displayed in the control.
imgHWIS Homothetic without enlargement: If the image can be entirely displayed in the control, it is displayed at 100%. Otherwise, the image is proportionally reduced in order to be entirely displayed.
imgNormal 100%: Image displayed at 100% in the upper-left corner of the control.
imgNoScale In "Large fonts" mode of Windows, the image displayed in an Image control is automatically zoomed.
The imgNoScale constant allows you not to zoom the image in "Large fonts" mode. This constant is useful for controls where a drawing is performed on a bitmap image coming from a screenshot.
This constant must be combined with one of the constants used to define the display mode of image.
This constant is not available.
imgStretched Stretched: Image stretched across the entire surface of the control.

Remarks

Inserting images

gImage can be used to insert an image:
- into the title and status bars of a window or into a Static control.
- into a Table control. In this case, the image must be inserted into a text column.
To display a text over an image:
- Insert an image with gImage,
- Describe the background color of the text with gBackground and the Transparent constant,
- Display the text.
  For example:
  
  ListAdd(LIST_ListView, gImage(ImagePath) + gBackground(Transparent) + gCoord(0, 0) + ...
  "Text")
If a row of a Combo Box control displays an image via gImage, when this row is selected, the image is re-used in the main row.

Image height (List Box or Combo Box control)

The height of the image displayed in an element of a List Box or Combo Box control is truncated to the number of pixels specified when the control was created ("Style" tab of the control description).

Image in the title of a column in a Table control

The TitleImage property is used to add an image to the title of a column in a Table control.

Business / UI classification: Neutral code

Component: wd270mdl.dll