Image Form Element

The Image form element displays an image in the form.

Example of the Image form element, shown in a Geocortex viewer

Image Properties

The Properties table describes the properties of the Image form element.

Property names in Workflow Designer's Properties panel are written using the capitalization and spacing of a title. Property names in expressions are valid JavaScript identifiers and start with a lower case letter. Expressions are case sensitive. When you access a form element property in an expression, you must use the correct capitalization.

In the table below:

Properties of the Image Form Element

Description

Type: String

A description of the element. The description appears below the element's title.

You can use the Description property to describe what the element represents or to provide instructions to the user about how to use the element.

You can format the description using Markdown.

Element ID

Type: String

The element's ID, which is used in other form elements and activities to access the element's properties. The ID must be unique across all elements in the form.

You cannot set the value of the Element ID property in an expression—you can only use the value that you configured for it. To use the Element ID property in an expression:

${Display Form ID}.state.{Element ID}.{property name}

For example:

$form1.state.image1.visible

error

Type: String | MarkdownRef

Indicates whether an error occurred in the element.

We recommend using the Set Form Element Error and Clear Form Element Error activities to work with errors in form elements.

Height

Type: Number

The height of the image in pixels.

You only need to set the height if you want the image to display at a certain height in the form. If you do not configure the height and width, the image displays at its actual size. Note that if the image is larger than the form, part of the image will not be visible.

Image URL

Type: String

The fully qualified URL of the image to display in the form.

You will not see the actual image in the form preview. A placeholder is used to represent the image in Workflow Designer.

styleName

Type: String

Indicates the name of the style that will be applied to the element.

To access the styleName property in an expression:

${Display Form ID}.state.{Element ID}.styleName

For example:

$form1.state.image1.styleName

Title

Type: String

The element's title, which appears at the top of the element. By default, the title is blank. You may want to change the title to describe what the element represents in your workflow.

You can format the title using Markdown.

Tooltip

Type: String

A message that displays when the user hovers the mouse pointer over the image. You may want to use the tooltip to provide help to the user.

type

Type: String

The variety of form element. Image elements are type "Image".

Use the type property to find out the variety of a form element in a form with many elements. Loop through ${Display Form ID}.state, comparing each element to the known form types and performing some action on the elements that meet your type criteria.

To access the type property in an expression:

${Display Form ID}.state.{Element ID}.type

For example:

$form1.state.image1.type

Visible

Type: Boolean

Name in Properties Panel: Visible

Name to Use in Expressions: visible

Indicates whether the element is visible to the user. By default, image elements are visible. If you want to hide the element, clear the Visible checkbox. You may want to change the visibility at run time depending on the user's input in a previous form element.

To access the visible property in an expression:

${Display Form ID}.state.{Element ID}.visible

For example:

$form1.state.image1.visible

Width

Type: Number

The width of the image in pixels.

You only need to set the width if you want the image to display at a certain width in the form. If you do not configure the height and width, the image displays at its actual size. Note that if the image is larger than the form, part of the image will not be visible.

Image Events

The following table describes the events associated with the Image form element. As in Workflow Designer, the events are listed in the order that they fire.

Events for the Image Form Element

load

The load event fires when the element finishes loading.

You can use the load event to set one or more of the element's properties at run time.