combit List & Label 27 - .NET Help
Programming Introduction / Examples / Web Reporting / Use of the Web Report Designer
In This Topic
    Use of the Web Report Designer
    In This Topic

    Web Report Designer runs completely independently in the browser and does not require any local installation of a Windows program, as is the case with Web Designer.

    In order to be able to use all Designer functions and objects, the Web Designer can still be used, but it requires a local Windows installation and is therefore no longer browser-independent.

     

    Requirements

    Integration - Create new Controller

    Then create a new controller as usual - in the following the name MyWebReportDesignerController is used as an example. Derive the controller from the WebReportDesignerController class:

    ...
    public class MyWebReportDesignerController : WebReportDesignerController
    ...
    
    ...
    Public Class MyWebReportDesignerController
            Inherits WebReportDesignerController
    ...
    

     

    Integration - Override important Methods

    Then implement the two abstract methods OnProvideListLabel and OnProvideRepository. Pass your List & Label instance with matching data source or the Repository to be used in the respective arguments provided.

    ...
    public override void OnProvideListLabel(ProvideListLabelContext provideListLabelContext)
    {
        ListLabel ll = new ListLabel();
        ll.LicensingInfo = "<ToDo: insert your license here>"
    
        var dataSource = GetDataProvider(provideListLabelContext.RepositoryItemId);
        ll.DataSource = dataSource;
    
        provideListLabelContext.NewInstance = ll;
    }
    
    public override void OnProvideRepository(ProvideRepositoryContext provideFileRepositoryContext)
    {
        provideFileRepositoryContext.Repository = GetRepository();
    } 
    ...
    
    ...
    Public Overrides Sub OnProvideListLabel(ByVal provideListLabelContext As ProvideListLabelContext)
    
        Dim ll As ListLabel = New ListLabel()
        ll.LicensingInfo = "<ToDo: insert your license here>"
    
        Dim dataSource = GetDataProvider(provideListLabelContext.RepositoryItemId)
        ll.DataSource = dataSource
    
        provideListLabelContext.NewInstance = ll
    
    End Sub
    
    Public Overrides Sub OnProvideRepository(ByVal provideFileRepositoryContext As ProvideRepositoryContext)
    
        provideFileRepositoryContext.Repository = GetRepository()
    
    End Sub
    ...
    

     

    In addition, the List & Label license key (see also LicensingInfo) must be specified.

     

    Integration - .NET Switch

    The further procedure differs for .NET Core/.NET 5/.NET 6 and .NET 4.x.

     

    .NET Core/.NET 5/.NET 6:

    In the startup.cs file, add the following lines to the end of the Configure method:

    ...
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // do some other stuff here
        // ...
    
        app.UseWebReportDesigner();
    }
    ...
    

    And in the ConfigureServices method, add this line:

    ...
    public void ConfigureServices(IServiceCollection services)
    {
        // do some other stuff here
        // ...
    
        services.AddWebReportDesigner();
    }
    ...
    

     

    .NET 4.x:

    In the global.asax.cs/global.asax.vb file, add the following line before the RouteConfig.RegisterRoutes() call:

    ...
    WebReportDesignerConfig.RegisterRoutes(RouteTable.Routes);
    ...
    
    ...
    WebReportDesignerConfig.RegisterRoutes(RouteTable.Routes)
    ...
    

     

    Using Web Report Designer

    The configuration is now complete. Now the Web Report Designer can be inserted and used in the desired view as follows:

    ...
    @using combit.Reporting.Web
    @{
        Layout = null;
    }
    <!DOCTYPE html>
    @Html.WebReportDesigner() 
    ...
    
    ...
    @using combit.Reporting.Web
    @{
        Layout = null;
        string repositoryId = Request.QueryString["reportRepositoryID"];
        if (!String.IsNullOrEmpty(repositoryId))
        {
            repositoryId = repositoryId.Replace("repository://{", "").Replace("}", "");
        }
    }
    <!DOCTYPE html>
    @Html.WebReportDesigner("Web Report Designer", repositoryId)
    ...
    

     

    Further

    The List & Label installation contains corresponding ASP.NET examples that show the use of the Web Report Designer in detail both under .NET Core and under .NET 4.x.