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

  The code below makes the appointment text bold.

  C#

  private void dayViewTimeCells1_AppointmentViewInfoCustomizing(object sender, DevExpress.XtraScheduler.AppointmentViewInfoCustomizingEventArgs e) {
      e.ViewInfo.Appearance.FontStyleDelta = System.Drawing.FontStyle.Bold;
  }
  

  VB.NET

  Private Sub dayViewTimeCells1_AppointmentViewInfoCustomizing(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.AppointmentViewInfoCustomizingEventArgs)
      e.ViewInfo.Appearance.FontStyleDelta = System.Drawing.FontStyle.Bold
  End Sub
  

• CustomDrawAppointment

  The code below displays the appointments that start past 12 PM as rectangles with gradient fill.

  C#

  private void dayViewTimeCells1_CustomDrawAppointment(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e) {
      DevExpress.XtraScheduler.Drawing.AppointmentViewInfo viewInfo = e.ObjectInfo as DevExpress.XtraScheduler.Drawing.AppointmentViewInfo;
      if (viewInfo.Interval.Start.TimeOfDay > new TimeSpan(12, 0, 0)) {
         e.Cache.FillRectangle(e.Cache.GetGradientBrush(e.Bounds, Color.Gray, Color.White, System.Drawing.Drawing2D.LinearGradientMode.BackwardDiagonal), e.Bounds);
         e.Handled = true;
      }
  }
  

  VB.NET

  Private Sub dayViewTimeCells1_CustomDrawAppointment(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
      Dim viewInfo As DevExpress.XtraScheduler.Drawing.AppointmentViewInfo = TryCast(e.ObjectInfo, DevExpress.XtraScheduler.Drawing.AppointmentViewInfo)
      If viewInfo.Interval.Start.TimeOfDay > New TimeSpan(12, 0, 0) Then
      e.Cache.FillRectangle(e.Cache.GetGradientBrush(e.Bounds, Color.Gray, Color.White, System.Drawing.Drawing2D.LinearGradientMode.BackwardDiagonal), e.Bounds)
      e.Handled = True
      End If
  End Sub
  

• CustomDrawAppointmentBackground

  The code below fills half of the appointment rectangle in yellow.

  C#

  private void dayViewTimeCells1_CustomDrawAppointmentBackground(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e) {
      e.DrawDefault();
      DevExpress.XtraScheduler.Drawing.AppointmentViewInfo viewInfo = e.ObjectInfo as DevExpress.XtraScheduler.Drawing.AppointmentViewInfo;
      e.Cache.FillRectangle(Brushes.Yellow, new Rectangle(viewInfo.InnerBounds.X, viewInfo.InnerBounds.Y, (int)(viewInfo.InnerBounds.Width * 0.5), viewInfo.InnerBounds.Height));
      e.Handled = true;
  }
  

  VB.NET

  Private Sub dayViewTimeCells1_CustomDrawAppointmentBackground(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
      e.DrawDefault()
      Dim viewInfo As DevExpress.XtraScheduler.Drawing.AppointmentViewInfo = TryCast(e.ObjectInfo, DevExpress.XtraScheduler.Drawing.AppointmentViewInfo)
      e.Cache.FillRectangle(Brushes.Yellow, New Rectangle(viewInfo.InnerBounds.X, viewInfo.InnerBounds.Y, CInt(viewInfo.InnerBounds.Width * 0.5), viewInfo.InnerBounds.Height))
      e.Handled = True
  End Sub
  

• CustomDrawTimeCell

  The code below draws red rectangles in place of time cells.

  C#

  private void dayViewTimeCells1_CustomDrawTimeCell(object sender, DevExpress.XtraScheduler.CustomDrawObjectEventArgs e) {
      e.Cache.FillRectangle(Brushes.Red, e.Bounds);
      e.Handled = true;
  }
  

  VB.NET

  Private Sub dayViewTimeCells1_CustomDrawTimeCell(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.CustomDrawObjectEventArgs)
      e.Cache.FillRectangle(Brushes.Red, e.Bounds)
      e.Handled = True
  End Sub
  

• InitAppointmentDisplayText

  The code below displays appointment duration in square brackets at the end of the appointment text.

  C#

  private void dayViewTimeCells1_InitAppointmentDisplayText(object sender, DevExpress.XtraScheduler.AppointmentDisplayTextEventArgs e) {
      e.Text = string.Format("{0} [{1:F2} h]", e.Text, e.Appointment.Duration.TotalHours);
  }
  

  VB.NET

  Private Sub dayViewTimeCells1_InitAppointmentDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.AppointmentDisplayTextEventArgs)
      e.Text = String.Format("{0} [{1:F2} h]", e.Text, e.Appointment.Duration.TotalHours)
  End Sub
  

• InitAppointmentImages

  The code below inserts an exclamation point in the appointment rectangle.

  C#

  private void dayViewTimeCells1_InitAppointmentImages(object sender, DevExpress.XtraScheduler.AppointmentImagesEventArgs e) {
      DevExpress.XtraScheduler.Drawing.AppointmentImageInfo info = new DevExpress.XtraScheduler.Drawing.AppointmentImageInfo();
      info.Image = SystemIcons.Warning.ToBitmap();
      e.ImageInfoList.Add(info);
  }
  

  VB.NET

  Private Sub dayViewTimeCells1_InitAppointmentImages(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.AppointmentImagesEventArgs)
      Dim info As New DevExpress.XtraScheduler.Drawing.AppointmentImageInfo()
      info.Image = SystemIcons.Warning.ToBitmap()
      e.ImageInfoList.Add(info)
  End Sub
  

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.