Verwendung des Web Report Designers
Der Web Report Designer läuft vollkommen unabhängig im Browser und bedarf keinerlei lokaler Installation eines Windows-Programms, wie es beim Web Designer der Fall ist.
Um alle Designer-Funktionen und -Objekte vollständig verwenden zu können, kann weiterhin der Web Designer verwendet werden, der jedoch eine lokale Windows Installation voraussetzt und somit auch nicht mehr browserunabhängig ist.
Voraussetzungen
- Um den Web Report Designer im eigenen ASP.NET Projekt zu verwenden, müssen die beiden List & Label NuGet Packages combit.ListLabel30 und combit.ListLabel30.Web hinzugefügt werden. Die weiteren externen Abhängigkeiten werden dabei automatisch hinzugefügt. Weitere Details zur Verwendung der NuGet Packages und dem Deployment finden sich unter NuGet Package Unterstützung.
- Zusätzlich suchen Sie die Zeile builder.Services.AddControllersWithViews(); und ersetzen Sie sie durch builder.Services.AddControllersWithViews().AddNewtonsoftJson();.
Einschränkungen
Generelle Einschränkungen im Web Report Designer im Vergleich zum normalen desktopbasierten Designer:
- keine interaktiven Formelfunktionen (AskString$, AskStringChoice$, LibraryPath$, ProjectPath$, ApplicationPath$)
- keine lokalen Dateipfade oder Formeln als Quelle für HTML-Objekte möglich
- keine OLE-Objekte
- keine Fax-/Mail-Funktionen
- keine eigenen DesignerActions
- keine im Callback selbst gezeichneten Objekte
Einbindung - Neuen Controller erstellen
Legen Sie anschließend wie üblich einen neuen Controller an - im Folgenden wird als Beispiel der Name MyWebReportDesignerController verwendet. Leiten Sie den Controller von der Klasse WebReportDesignerController ab:
...
public class MyWebReportDesignerController : WebReportDesignerController
...
...
Public Class MyWebReportDesignerController
Inherits WebReportDesignerController
...
Einbindung - Wichtige Methoden überschreiben
Implementieren Sie dann die beiden abstrakten Methoden OnProvideListLabel und OnProvideRepository. Übergeben Sie in den jeweils bereitgestellten Argumenten Ihre List & Label-Instanz mit passender Datenquelle bzw. das zu verwendende Repository.
...
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.FileRepository = DefaultSettings.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.FileRepository = DefaultSettings.GetRepository()
End Sub
...
Für die Weitergabe ist es wichtig, dass zusätzlich unbedingt der List & Label Lizenzschlüssel (siehe auch LicensingInfo) in OnProvideListLabel() für die List & Label-Instanz angegeben wird.
Hinweis: Eine detaillierte Implementierung für DefaultSettings.GetRepository() in OnProvideRepository() finden Sie in den mitgelieferten ASP.NET Beispielen.
Einbindung - .NET Weiche
Die weitere Vorgehensweise unterscheidet sich bei .NET 6/.NET 8/.NET 9 und .NET 4.8.
.NET 6/.NET 8/.NET 9:
Wenn Sie die Datei startup.cs vorfinden (ansonsten siehe unten), fügen Sie die folgenden Zeilen am Ende der Configure-Methode hinzu:
...
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// do some other stuff here
// ...
app.UseWebReportDesigner();
}
...
Und in der ConfigureServices-Methode fügen Sie noch diese Zeile hinzu:
...
public void ConfigureServices(IServiceCollection services)
{
// do some other stuff here
// ...
services.AddWebReportDesigner();
}
...
Wenn es die Datei startup.cs nicht gibt, sollten Sie die Datei program.cs haben. In diesem Fall fügen Sie app.UseWebReportDesigner(); direkt nach jedem anderen app.Use...-Aufruf und builder.Services.AddWebReportDesigner(); direkt nach jedem anderen builder.Services...-Aufruf hinzu.
.NET 4.8:
Fügen Sie in der Datei global.asax.cs/global.asax.vb vor dem RouteConfig.RegisterRoutes()-Aufruf die folgende Zeile ein:
...
WebReportDesignerConfig.RegisterRoutes(RouteTable.Routes);
...
...
WebReportDesignerConfig.RegisterRoutes(RouteTable.Routes)
...
Web Report Designer verwenden
Damit ist nun die Konfiguration abgeschlossen. Nun kann im gewünschten View der Web Report Designer wie folgt eingefügt und verwendet werden:
...
@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)
...
Ausblick
In der List & Label Installation finden sich entsprechende ASP.NET Beispiele, die die Verwendung des Web Report Designers im Detail zeigen.