DHTML Frame API

The DHTML Frame API is a small JavaScript library that enables you to partly build your own DHTML Report Viewer. The DHTML viewer is divided into three main parts:

• a main viewer that displays the contents of the report
• a navigation tree that displays the different levels of grouping in the report, and allows the user to quickly jump to a particular group.
• a toolbar that provides several functions for navigating and controlling the report.

Of these three main areas, only the toolbar is available for manipulation. That is, you may write your own toolbar, but may not modify either the group tree or the main report viewer.

When a page is loaded that uses a custom toolbar and the report viewer the following process follows:

1. The page is loaded and the HTML API is notified.
2. The API notifies the custom toolbar through the onReportPageLoad function.
3. The toolbar processes any custom code.

To learn how to write your own toolbar, see Creating a custom toolbar in the Crystal Enterprise Tutorial.

The toolbar offers the following functionality through the DHTML Frame API:

Function	Description
gotoPage Function	Navigates to a page in the report.
toggleGrouptree Function	Toggles the group navigation tree on and off.
doRefresh Function	Refreshes the report with new data.
doTextSearch Function	Searches the report for text.
setDrillDownLevel Function	Drills down on summarized data.