RWA_IMAGE_FUNCTION


Purpose

Creates an image button for an HTML document that invokes a function. Outputs generated code to vText buffer. Up to three images can be specified for display on the button (see also RWA_IMAGE_ANCHOR).

Syntax

RWA_IMAGE_FUNCTION(vString, JSFunction, Description, aImageURLArray, aClass)

Parameters

vString A variable containing the string to which the generated code is appended. On return, the variable contains the modified string. If the string does not exist, it is created.

JSFunction JavaScript function to be called when the image is clicked.

Description Alternative text for the image (the text displayed if the image cannot be displayed).

aImageURLArray
A containing up to 3 image URLs:

  • Element 1 specifies the default for the image.
  • Element 2, if specified, is the URL of the image to be displayed when the mouse is over the image.
  • Element 3, if specified, is the URL of the image to be displayed when the user clicks on the image.

aClass A that can contain the following elements:

Element No.

Attribute

Description

1

CLASS

The name of a tag class defined in a stylesheet.

2

ALT

Alternative text that is displayed instead of the image, if image display is not possible or disabled by the user.

This must be a text string of up to 1024 characters. It can contain entity references to special characters, but cannot contain any other sort of markup; in particular, no style tags are allowed.

Attributes defined in the aClass parameter are applied to the INPUT tag.

For information about using aClass, see The aClass Parameter.