Polybench® Reference
Allows to display images from the project's image repository. The images displayed can be changed by Project Actions.

Picture Viewer

Overview

Use this object to display changing images. The image that is displayed can be changed by setting the name of an image in the Image Repository in the ImageName variable, by using a SET_PARAMETER action.

Properties

Find more information about changing properties here: "Properties Viewer"

ImageName
type: Known image name
The name of the image in the image repository.

This property uses the Image Repository. For more information about the use of images in a project, refer to "Image Repository"

Stretched
type: True or False
Set to true to have the image stretched to the size of the Picture Viewer, or false to have it zoomed to the largest possible size.
Select one of those presets:
True or False
True may also be read like 'yes' and false like 'no'


BackgroundColor
type: Known color name
The background color of the picture viewer

This property uses the Color Repository. For more information about the use of colors in a project, refer to "Color Repository"

Size
type: Size containing width and height
The size of the user interface of this object (width, height).


Coordinates
type: Coordinate
The location of the user interface of this object in (x,y) coordinates, relative to the object it is on top of.


Caption
type: Word or phrase
The name of the object in the project. This name must not contain '.', '$' nor '@' characters.

For more information about the rules and usage of the Caption property, please refer to "Caption property - background and usage".

Documentation
type: See description
Optional documentation of this object. If this object is an operator, the Documentation text is displayed below the operator symbol.

Variable Parameters

Find more information about Variable Parameters here: "Variable Parameters"

ImageName
type: See description
The name of an image in the image repository that is displayed in the Picture Viewer.

Details

Note that the difference between a Static Image ("Static Image") object and a Picture Viewer object is that the Static Image should be used to display static images (for example a background, or a logo), and that the Picture Viewer can be used to display images that are changed during the running of the project.

You can use Project Actions to set the variable parameter ImageName of the Picture Viewer. The name of the image in ImageName should be available in the Image Repository ("Image Repository").