Image Viewer

This component displays an image from a resource folder. The image shown is controlled by Image Controllers. It also has slide show functions. The Image Controllers are dependant on the Image Viewer for their functionality.

The Image Viewer Component

Properties

Name

Type

Description

Resource Folder

The resource folder used to display images.

Channel

Enum

The channel on which this component is operating. Other Image Controls and the Image Viewer also has this setting. The channels available are 1-15.

View Mode

Enum

Determines in which modes the component is visible. Possible values:

Always
Never
Playing
Stopped
Overview
Single
Playing - Overview
Playing - Single
Stopped - Overview
Stopped - Single

Start View Mode

Enum

Determines which mode the component starts in. Possible values:

Overview
Single

Page Size

Integer

Used to display the size of the pages in the text.

Frame Style

Enum

Decides how the frame will be displayed. Possible values:

No Frame
Adaptive
Fixed

Fixed Background Color

Color

The color used for the background inside of the frame if the Frame Style property is set to Fixed.

Fixed Frame Inner Width

Integer

The inner width in pixels of the frame if the Frame Style property is set to Fixed.

Fixed Frame Inner Height

Integer

The inner height in pixels of the frame if the Frame Style property is set to Fixed.

Frame Corners

Resource

The image used for the corners of the frame.

Frame Horizontal Fill

Resource

The image used for the horizontal parts of the frame.

Frame Vertical Fill

Resource

The image used for the vertical parts of the frame.

Start Image

Enum

Determines which image should be loaded first. Possible values:

First
None
Random

Preload Images

Bool

If set to true, all the images will be loaded in the background while the page is displaying.

Image Command

Enum

The command issued when the image is clicked. Possible values:

None
Previous (Shows the previous image)
Next (Shows the next image)
First (Shows the first image)
Last (Shows the last image)
Play (Starts the slide show and sets it in playing mode)
Stop (Stops the slide show and sets it in stopped mode)
Overview Mode (Sets the overview mode)
Single Mode (Sets the single mode)
Custom Action (Performs the Custom Action)

Custom Action

Action

Custom action performed if selected for the Image Command property.

Show Image Tool Tips

Bool

If set to true, the tool tip will be shown for the displayed image.

Image Text Position

Enum

The position of the image text. Possible values:

No Text
Top
Bottom

Image Text

String

If not empty, this string is shown with the image. The string can contain special keywords which will be replaced by the component.

Keyword	Replaced by
#count	The order number.
#maxcount	The total number of images.
#page	The page order number.
#maxpage	The total number of pages.
#filename	The filename of the image.
#title	The title of the image.
#alt	The tool tip text of the image.
#description	The description of the image.
#width	The width in pixels of the image.
#height	The height in pixels of the image.
#filesize	The filesize in bytes of the image.

Image Text Style

Style

The style used for the Image Text.

Image Text Alignment

Enum

The alignment of the Image Text. Possible values:

Top Left	Top	Top Right
Left	Center	Right
Bottom Left	Bottom	Bottom Right

Transition Effect (IE Only)

Enum

Transition Effect. Only available for Internet Explorer browsers. (Version 5.5 or later) Other browsers will have no transitions. Possible values:

None
Barn(motion=out, orientation=horizontal)
Barn(motion=out, orientation=vertical)
Barn(motion=in, orientation=horizontal)
Barn(motion=in, orientation=vertical)
Blinds(direction=up, bands=<param1>)
Blinds(direction=down, bands=<param1>)
Blinds(direction=left, bands=<param1>)
Blinds(direction=right, bands=<param1>)
Checkerboard(direction=up, squaresx=<param1>, squaresx=<param2>)
Checkerboard(direction=down, squaresx=<param1>, squaresx=<param2>)
Checkerboard(direction=left, squaresx=<param1>, squaresx=<param2>)
Checkerboard(direction=right, squaresx=<param1>, squaresx=<param2>)
Fade(overlap=<param1/100.0>)
Gradientwipe(motion=forward, gradientsize=<param1/100.0>)
Gradientwipe(motion=reverse, gradientsize=<param1/100.0>)
Inset()
Iris(motion=out, irisstyle=diamond)
Iris(motion=out, irisstyle=circle)
Iris(motion=out, irisstyle=cross)
Iris(motion=out, irisstyle=plus)
Iris(motion=out, irisstyle=square)
Iris(motion=out, irisstyle=star)
Iris(motion=in, irisstyle=diamond)
Iris(motion=in, irisstyle=circle)
Iris(motion=in, irisstyle=cross)
Iris(motion=in, irisstyle=plus)
Iris(motion=in, irisstyle=square)
Iris(motion=in, irisstyle=star)
Pixelate(maxsquare=<param1/100.0>)
Radialwipe(wipestyle=clock)
Radialwipe(wipestyle=wedge)
Radialwipe(wipestyle=radial)
Randombars(orientation=horizontal)
Randombars(orientation=vertical)
Randomdissolve()
Slide(slidestyle=hide, bands=<param1>)
Slide(slidestyle=push, bands=<param1>)
Slide(slidestyle=spin, bands=<param1>)
Spiral(gridsizex=<param1>,gridsizey=<param2>)
Stretch(stretchstyle=hide)
Stretch(stretchstyle=push)
Stretch(stretchstyle=spin)
Strips(motion=leftdown)
Strips(motion=leftup)
Strips(motion=rightdown)
Strips(motion=rightup)
Wheel(spokes=<param1>)
Zigzag(gridsizex=<param1>,gridsizey=<param2>)

Duration

Float

Duration of transition in seconds.

Transition Parameter 1

Integer

Transition effect parameter 1 (<param1>)

Transition Parameter 2

Integer

Transition effect parameter 2 (<param2>)

Slide Show Mode

Enum

Slide show mode used. Possible values:

Off
On - Stop at end
On - Restart at end
On - Action at end

Slide Show Random Mode

Bool

If set to true, the slide show will show the images in random order.

Slide Show Action At End

Action

Action performed at end of slide show, if the Slide Show Mode property is set to "On - Action at end".

Slide Show Auto Start

Bool

If set to true, and the Slide Show property is set to On, the slide show will start automatically.

Slide Show Interval

Float

The time in seconds between slides when running the slide show.