Class actuate.viewer.ViewerException

Description

A container for an exception. ViewerException provides an object to pass to a handler when the user-defined ON_EXCEPTION event occurs. It contains a reference to the element that generated the exception.

Constructor

The ViewerException object is constructed when an ON_EXCEPTION event occurs. The exceptions are divided into three types, which determine the contents of the Exception object. These types are:

ERR_CLIENT: Exception type for a client-side error

ERR_SERVER: Exception type for a server error

ERR_USAGE: Exception type for a JSAPI usage error

Function summary

Table 11‑14 describes the actuate.viewer.ViewerException function.

Table 11‑14 actuate.viewer.ViewerException function
Function	Description
getErrorMessage( )	Returns the exception message

actuate.viewer.ViewerException.getErrorMessage

Syntax

string ViewerException.getErrorMessage( )

Returns the error message for the exception.

Returns

String. A server error message.

Example

This example displays the server error code in an alert box:

alert("Server error message: " + vException.getErrorMessage( ));