Image Display Registry entry

Specify an image to display alongside Summary Data in a module window, and in a column in List View.

Usage

This Registry entry can be assigned to users and groups:

Key User User Group Group Group Group
Key 1 User User Group Group Group Group
Key 2 user user group group Default Default
Key 3 Table Table Table Table Table Table
Key 4 table Default table Default table Default
Key 5 Image Display
Key 6 column
Key 7 search value
Value image[;sound[;hint[;alt text]]]
User user Table table Image Display column search value image[;sound[;hint[;alt text]]]
User user Table Default Image Display column search value image[;sound[;hint[;alt text]]]
Group group Table table Image Display column search value image[;sound[;hint[;alt text]]]
Group group Table Default Image Display column search value image[;sound[;hint[;alt text]]]
Group Default Table table Image Display column search value image[;sound[;hint[;alt text]]]
Group Default Table Default Image Display column search value image[;sound[;hint[;alt text]]]

It is also possible to test for the existence of data in a field rather than for an exact value using the following variations:

Group Default Table table Image Display column search value image[;sound[;hint[;alt text]]]
Group Default Table Default Image Display column search value image[;sound[;hint[;alt text]]]

where:

column

is the name of the column to check for value. If value is found in column (or is one of the values in a table), the rest of the Registry entry is evaluated.

search value

 

is the value to search for in column. If search value is found in column (or is one of the values in a table), the rest of the Registry entry is evaluated.

To be matched, search value must be found in column exactly as specified and on its own line / in its own row.

For example, if search value = warning and the data in column is:

  • warning, there is a match, e.g.:

  • warnings, there is no match.

  • this is a warning, there is no match, e.g.:

The same holds for rows in a column:

  • This will match:

  • This will not match:

The value in Key 7 (search value) can also be:

NULL

will match an empty column.

NOT NULL

will match a column with data.

image

is the name of the image file to display. The file must be located on the EMu server in the ~EMu/client/etc/images directory. The image file is cached on the client as required. The image may be any file type supported by the EMu Multimedia Repository (e.g. bmp, png, gif, tiff, tga, pcx, pcd, jpeg, dcx).

When retrieving an image file from the server, EMu will first try to retrieve a resolution specific image (21x21 or 42x42). If this image is not found, the specified image file is retrieved. The resolution specific image makes it possible to have two images per Image Display entry, one shown with Thumbnails disabled and the other shown with Thumbnails enabled.

If Thumbnails (View>Thumbnails) is disabled, the file image21x21.ext is first tried, then image.ext. For example, the Registry entry:

Group Default Table ecatalogue Image Display HazHazardous_tab toxic toxic.jpg;toxic.wav

will result in EMu first trying to retrieve toxic21x21.jpg; if this file is not found in ~emu/client/etc/images, then toxic.jpg would be fetched.

If Thumbnails is enabled and the above Registry entry used, EMu would first try to retrieve toxic42x42.jpg; if this file is not found in ~emu/client/etc/images, then toxic.jpg would be shown.

sound

is optional. The sound will be played after the image is displayed. The sound file must be located on the EMu server in the ~emu/client/etc/images directory. The sound file must be in .wav format.

hint

is optional. The hint is shown when the mouse cursor hovers over the displayed image. The hint message is multilingual, with the text for the prompt language being used.

alt text

is optional. If the image display is included in a List View column and a row is copied and pasted, this is the text that will be pasted in place of the image. If no alt text is specified, the file name of the image (without the file extension) is pasted (if the file name is world.gif, the paste text will be world).

In order to include the image display in a List View, it is necessary to add the Image Display Icons column to the List View (details about configuring a List View can be found here):

When records are viewed using the List View, the image specified in the Image Display Registry entry will be included when the conditions specified in the entry are met:

Image Display

It is possible to copy and paste rows in List View (right-click a row and select Copy from the context menu that displays). If we copy a row that includes an image, and paste the data, any text specified as alt text will be pasted in place of the image; if no alt text is specified, the file name of the image is pasted (without the file extension; if the file name is world.gif, the paste text will be world).

In this example, alt text = This is the paste text! and the third row in the List View above was copied and pasted into Excel:

See Example 3 below.

Note: It is possible to display multiple images. If the same image would be displayed more than once, only the first instance is shown. Hence it is possible to display just one image display where multiple values are matched. Also the same named sound file will only be played once. See last example below for details.

Example 1

To identify that an object contains hazardous materials, the field HazHazardous_tab contains the term toxic. In order for a warning image to display and sound to play when the record is accessed, the following Registry entry may be used:

Key Setting Description
Key 1 Group  
Key 2 Default  
Key 3 Table  
Key 4 ecatalogue  
Key 5 Image Display  
Key 6 HazHazardous_tab The HazHazardous_tab field is searched for the value (toxic) and if found, the image will be displayed and the sound played.
Key 7 toxic

Value

 toxic.jpg;toxic.wav These files must be stored on the EMu server in the ~emu/client/etc/images directory.

Example 2

A warning image is displayed and a sound played when a record is accessed where there is any value in the HazHazardous_tab field:

Key Setting
Key 1 Group
Key 2 Default
Key 3 Table
Key 4 ecatalogue
Key 5 Image Display
Key 6 HazHazardous_tab
Key 7 NOT NULL

Value

 toxic.jpg;toxic.wav

Example 3

When there is any value in the HazHazardous_tab field, a warning image is displayed; if a List View is configured to include the image, copying and pasting a row from the List View will paste a warning, Caution is required!, rather than the name of the image:

Key Setting
Key 1 Group
Key 2 Default
Key 3 Table
Key 4 ecatalogue
Key 5 Image Display
Key 6 HazHazardous_tab
Key 7 NOT NULL

Value

 toxic.jpg;;;Caution is required!

Example 4

Images are displayed if a record contains certain chemicals. A hint is given for each chemical:

Column

Value

Image

Sound

Hint
MatMaterials_tab Sulphur sulphur.gif - Sulpher
Magnesium magnesium.gif - Magnesium
Uranium uranium.gif warning.wav Uranium
Plutonium plutonium.gif warning.wav Plutonium

The following Registry entries may be used:

Key Setting Description
Key 1 Group  
Key 2 Default  
Key 3 Table  
Key 4 ecatalogue  
Key 5 Image Display  
Key 6 MatMaterial_tab

MatMaterial_tab is searched for the word sulphur; if found, the sulphur.gif image displays; no sound is played (note the two semicolons together: no sound file is specified between the image file and the hint but it is necessary to account for a sound file as EMu assumes an image file is followed by a sound file, followed by a hint), but there is a hint that states Sulphur.
Key 7 sulphur
Value sulphur.gif;;Sulphur

 

Key Setting
Key 1 Group
Key 2 Default
Key 3 Table
Key 4 ecatalogue
Key 5 Image Display
Key 6 MatMaterial_tab
Key 7 magnesium
Value magnesium.gif;;Magnesium
Key Setting
Key 1 Group
Key 2 Default
Key 3 Table
Key 4 ecatalogue
Key 5 Image Display
Key 6 MatMaterial_tab
Key 7 uranium
Value uranium.gif;warning.wav;Uranium
Key Setting
Key 1 Group
Key 2 Default
Key 3 Table
Key 4 ecatalogue
Key 5 Image Display
Key 6 MatMaterial_tab
Key 7 plutonium
Value plutonium.gif;warning.wav;Plutonium

If a record contains more than one of the materials listed above, an image will display for each material.

Example 5: Bi-lingual hint

If the column MatMaterials_tab contains the word toxic, the image is shown with a hint. The following Registry entry may be used:

Key Setting Description
Key 1 Group  
Key 2 Default  
Key 3 Table  
Key 4 ecatalogue  
Key 5 Image Display  
Key 6 MatMaterial_tab  
Key 7 toxic  
Value toxic.gif;;Toxic;:;toxique The correct hint, toxic (English) or toxique (French) will be displayed depending on the prompt language selected by the user.

Example 6

If the same image display is specified for a list of chemicals, only one image will display if a record contains more than one of the chemicals.

If the following Registry entries existed and a record contained cyanide and sulphur, hazardous.gif would only display once:

Key Setting 1 Setting 2
Key 1 Group Group
Key 2 Default Default
Key 3 Table Table
Key 4 ecatalogue ecatalogue
Key 5 Image Display Image Display
Key 6 MatMaterial_tab MatMaterial_tab
Key 7 sulphur cyanide
Value hazardous.gif;warning.wav;Hazardous hazardous.gif;warning.wav;Hazardous
Key Setting 3 Setting 4
Key 1 Group Group
Key 2 Default Default
Key 3 Table Table
Key 4 ecatalogue ecatalogue
Key 5 Image Display Image Display
Key 6 MatMaterial_tab MatMaterial_tab
Key 7 uranium plutonium
Value hazardous.gif;warning.wav;Hazardous hazardous.gif;warning.wav;Hazardous