ChartDirector 7.1 (.NET Edition)

JsChartViewer.serverErrorMsg


Description

Gets or sets the HTML template for displaying server error messages.

When a partial update error occurs, the default behaviour is to display the error message on the chart. (See JsChartViewer.UpdateError on how to change the default behaviour.) This property determines the format to display the error message.

The format should be written in HTML, using "%errCode" and "%errMsg" as the place holder for the error code and the error message. The template may include JsChartViewer.okButton or JsChartViewer.xButton for putting an "OK" or an "X" (close window) button in the template for closing the error message window.

If the template begins with the <DIV> tag, then the template will be used as is, otherwise the template will be put into a container first as defined by JsChartViewer.msgContainer before use.

This property is available as both a static property (class property) and an instance property. If you set the static property (class property) using JsChartViewer.updatingMsg, then all JsChartViewer objects will be affected. If you set the instance property using objName.updatingMsg, then only the object being configured will be affected.

As an example, the default JsChartViewer.serverErrorMsg is:

JsChartViewer.serverErrorMsg = JsChartViewer.xButton + '<div style="font-family:Arial; font-weight:bold; font-size:15pt;">' + 'Error %errCode accessing server</div><hr>%errMsg';

The above means that the error message will be display using the default message container, with an "X" button on top for closing the window, followed by a title line showing the error code, followed by the horizontal line separator, and finally the error message.