RefreshFieldListService Class

Enables you to specify options that affect how the Field List is refreshed.

Namespace: DevExpress.XtraReports.Web.ReportDesigner.Services

Assembly: DevExpress.XtraReports.v20.1.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public class RefreshFieldListService

VB.NET

Public Class RefreshFieldListService

Remarks

Create a descendant of the RefreshFieldListService class and override the MaxNestingLevelUpdate property. It specifies the maximum nesting level of field list nodes whose data are queried when the Field List refreshes.

The code snippets below demonstrate how to use this service to minimize the amount of data requested to refresh the Field List.

1. Implement a derived class and override its methods.

   C#

   using DevExpress.XtraReports.Web.ReportDesigner.Services;
   
     public class MyRefreshFieldListService : RefreshFieldListService
     {
         public override int MaxNestingLevelUpdate => 1;
   
     }
   

   VB.NET

   Imports DevExpress.XtraReports.Web.ReportDesigner.Services
   
   Public Class MyRefreshFieldListService
     Inherits RefreshFieldListService
   
       Public Overrides ReadOnly Property MaxNestingLevelUpdate() As Integer
         Get
           Return 1
         End Get
       End Property
   
   End Class
   

2. Register the class implemented in the previous step as a custom service at the application’s startup.

   • ASP.NET Web Forms and ASP.NET MVC

     C#

     using DevExpress.XtraReports.Web.ReportDesigner.Services;
     
       void Application_Start(object sender, EventArgs e) {
         DefaultReportDesignerContainer.Register<RefreshFieldListService, MyRefreshFieldListService>();
       }
     

     VB.NET

     Imports DevExpress.XtraReports.Web.ReportDesigner.Services
     
       Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
           DefaultReportDesignerContainer.Register(Of RefreshFieldListService, MyRefreshFieldListService)()
       End Sub
     

   • ASP.NET Core

     C#

     using DevExpress.XtraReports.Web.ReportDesigner.Services;
     
       public void ConfigureServices(IServiceCollection services) {
           // ...
           services.AddSingleton<RefreshFieldListService, MyRefreshFieldListService>();
       }
     

Inheritance

Object

RefreshFieldListService