1100 Custom

FrameType = 1008

The 1100 Custom section enables you to override the default behavior of most standard dashboard controls.

1100 Custom is hidden each time a dashboard is opened, so use View, then Unhide Section to make it visible before modifying the code.

For each customizable standard control; for example, navigation controls, filter controls, toolbar buttons, and so on, there is a corresponding control in 1100 Custom. The event handlers for these controls define the functions that are used to override the default behavior.

Note:

In the default template, override functions are usually commented-out. When adding code, ensure that the function is called by removing surrounding comment markers.

Two override functions are available:

Pre-process Function—Called before the standard processing
Post-process Function—Called after the standard processing

If the pre-process function returns true, the standard processing continues and the post-process function is called when the standard processing is complete. If the pre-process function returns false, the standard processing is not performed and the post-process function is not called.

It is not necessary to enable pre- and post-process functions for a control as the template checks if a pre- or post- process function is defined before calling it, and a missing pre-process function is assumed to have returned true, meaning the standard processing occurs and the post-process function (if defined) is called.

The list illustrates the flow of control:

Click a control (for example, picPrint).
The generic control handler is called.
The control handler identifies and calls the specific handler.
The specific handler calls the pre-process function for the control in 1100 Custom.
If the pre-process function returns true, the specific handler continues and calls the post-process function in 1100 Custom before it exits.
If the pre-process function returns false, the specific handler exits with no further processing.

Custom JavaScript can be placed in the pre- or post-process function depending on the required effect.

The gtxlLanguageStrings label is used to contain text that is sensitive to the set dashboard language. The gtxlLanguageStrings are used as part of general display or in drop-down lists. The dashboard loads them in the hashed array called ActiveDocument.Qiq_harConstants. The format of the label is:

<text_id1>=<lang1_id>~<lang1_value1>|<lang2_id>~<lang2_value1>, and so on.

<text_id2>=<lang1_id>~<lang1_value2>|<lang2_id>~<lang2_value2>, and so on.

For example,

MONTH_JAN=ENUS~Jan|FRFR~Jan|DEDE~Jan|ESES~ene
MONTH_FEB=ENUS~Feb|FRFR~F%E9v|DEDE~Feb|ESES~feb

The language values should be escaped so they do not cause problems if they contain embedded separators or other special characters. For example, (=), (~), (|), and carriage returns.

You can use the JavaScript escape() function to create strings. For example, if the text is Ref=danger~trouble|strife, enter it in the Interactive Reporting Studio Console window:

Console.Writeln(escape("Ref=danger~trouble|strife"))

You can copy the escaped values from the Console window, which in this case is:

Ref%3Ddanger%7Etrouble%7Cstrife

The gtxlToolTip label is used to hold the text that is to be shown as a floating comment when the specialized control is pressed. The format of the label is identical for gtxlLanguageStrings. The dashboard loads them in the hashed array called ActiveDocument.Qiq_harToolTip.

Tip:

If you are changing the nature of the operation, consider changing the graphic that is associated with the operation. A detailed discussion of the programming required is outside the scope of this guide.