Scripting

Apr 07, 2022
3 minutes to read

The End-User Report Designer enables end-users to write report scripts. Scripts are custom event handlers that can be added for specific events of Scheduler report controls, bands, Scheduler views or a report itself.

How to Write a Script

To write a script, switch to the Script tab of the End-User Designer, select a report element in the drop-down list as illustrated below and specify one of its available events in the next drop-down list:

To check for errors in a report script, click the Validate button. If errors are found, they are listed in the Error List panel.

To execute the script, switch to the Preview tab:

Note

The XtraReport.ScriptLanguage property specifies a language ( C# - default, Visual Basic .NET or JScript .NET ) that is used by all scripts in a report. The scripting language is independent from the language used to create the report.

To learn more about report scripts, refer to the Scripting in XtraReports topic.

Script Examples

The following events are supported in scripts for the TimeCellsControlBase descendants:

AppointmentViewInfoCustomizing
CustomDrawAppointment
CustomDrawAppointmentBackground
CustomDrawTimeCell
InitAppointmentDisplayText
InitAppointmentImages

Note

Use the CustomDrawObjectEventArgs.Cache property to paint shapes, write a text and insert images. Do not use the CustomDrawObjectEventArgs.Graphics object in Scheduler Reports.