Script Editor

The Script Editor allows end-users to write code for specific event handlers in the End-User Report Designer to adjust the behavior of report controls, bands or the report itself.

WPFDesigner_ScriptEditor

This topic describes the basics of using scripts, the Script Editor interface and shows how to use scripting in a report.

Scripts Overview

The Script Editor provides end-users with the capability to write and execute scripts at runtime when a report is generated. Note that this feature is primarily intended to be used by advanced end-users who want to slightly customize a report in the End-User Report Designer.

The Script Editor supports C# and Visual Basic .NET scripting languages. This means that the scripting language is independent from the language used to create the report. You can specify the language using the XtraReport.ScriptLanguage property. The selected scripting language should be the same for all scripts used in a report.

WPFDesigner_ScriptLanguageProperty

Maintaining Scripts

Each report element has its own set of events, which are individual for each element type. To handle an event of a report element, do one of the following.

  • Select the required report element on the Design Surface. In the Properties Panel, expand the Scripts property and click the plus button for the event.

    WPFDesigner_AddingScriptViaPropertiesPanel

  • Click the Scripts button (WPFDesigner_Toolbar_ScriptEditor) in the Toolbar to display the Script Editor. Choose the required report element in the dedicated drop-down list at the left top of the Script Editor. Then, select one of the available events in another list at the right top.

    WPFDesigner_AddingScriptViaScriptEditor

After the event is specified, a code template is automatically generated in the current scripting language and added in the Script Editor.

WPFDesigner_ScriptTemplate

To check for errors in the report's script, click the Validate button. The validation result is displayed in the errors panel at the bottom of the Script Editor. Double-click the error item in the panel's list to go to the corresponding line of code. If all scripts are valid, the errors panel is empty.

WPFDesigner_ScriptErrorPanel