How to: Execute Custom Code when a Report is Persisted

• Oct 09, 2020
• 2 minutes to read

This topic describes how you can customize the ReportsStorage class. Assume you have a customized the ReportDataV2 class and added the ModifiedBy property that should return the name of the user who last edited the report layout. You need to update this property value each time a report layout is saved. For this purpose, customize the ReportsStorage and register your custom implementation. The steps below demonstrate how to do it.

• Inherit the ReportsStorage class and override its ReportsStorage.SaveReport method.

  C#

  using DevExpress.XtraReports.UI;
  using DevExpress.ExpressApp;
  using DevExpress.ExpressApp.ReportsV2;
  using DevExpress.ExpressApp.Security;
  // ...
  public class CustomReportsStorage : ReportsStorage {
      public override void SaveReport(IReportDataV2Writable reportData, XtraReport report) {
          if (reportData is MyReportDataV2) {
              ISecurityUser currentUser = SecuritySystem.CurrentUser as ISecurityUser;
              if (currentUser != null) {
                  ((MyReportDataV2)reportData).ModifiedBy = currentUser.UserName;
              }
          }
          base.SaveReport(reportData, report);
      }
  }
  

  VB.NET

  Imports DevExpress.XtraReports.UI
  Imports DevExpress.ExpressApp
  Imports DevExpress.ExpressApp.ReportsV2
  Imports DevExpress.ExpressApp.Security
  ' ...
  Public Class CustomReportsStorage
      Inherits ReportsStorage
  
      Public Overrides Sub SaveReport(ByVal reportData As IReportDataV2Writable, ByVal report As XtraReport)
          If TypeOf reportData Is MyReportDataV2 Then
              Dim currentUser As ISecurityUser = TryCast(SecuritySystem.CurrentUser, ISecurityUser)
              If currentUser IsNot Nothing Then
                  CType(reportData, MyReportDataV2).ModifiedBy = currentUser.UserName
              End If
          End If
          MyBase.SaveReport(reportData, report)
      End Sub
  End Class
  

• Edit the Module.cs (Module.vb) file and override the ModuleBase.Setup method. In this method, assign an instance of the CustomReportsStorage to the static ReportDataProvider.ReportsStorage property.

  C#

  using DevExpress.ExpressApp.ReportsV2;
  // ...
  public override void Setup(XafApplication application) {
      ReportDataProvider.ReportsStorage = new CustomReportsStorage();
      base.Setup(application);
  }
  

  VB.NET

  Imports DevExpress.ExpressApp.ReportsV2
  ' ...
  Public Overrides Sub Setup(ByVal application As XafApplication)
      ReportDataProvider.ReportsStorage = New CustomReportsStorage()
      MyBase.Setup(application)
  End Sub