Integrating the WinUI Report Viewer in .NET 6
This article explains the steps needed to integrate the WinUI report viewer to a .NET 6 project.
Prerequisites:
- Visual Studio 2022 or newer
- Windows 10 SDK 10.0.18362 or newer
- .NET 6 project
Use the example projects as a reference
Since R1 2023, the examples we distribute along with our product contain two new projects: CSharp.Net6.WinUIIntegrationDemo and CSharp.Net6.WinUIIntegrationDemo (Package). These projects are designed as a showcase of our WinUI report viewer and can be used as a reference when configuring the viewer in your own WinUI application.
The project CSharp.Net6.WinUIIntegrationDemo.csproj targets .NET 6 and contains the references to the necessary Nuget packages. This project also contains the XAML files that configure the application and the window that will host the ReportViewer control. The project CSharp.Net6.WinUIIntegrationDemo.wapproj is a Windows Application Packaging Project and specifies which project will be packed as .appx and loaded for execution.
These projects are not included in our CSharp.ReportExamples.sln file as the rest of the example projects, because building a WinUI application would require a specific configuration of the development machine and that might ruin the smooth "getting started" experience we want to deliver to our users. In order to run the WinUI example projects, make sure the prerequisites above are met and follow the steps below:
- Open Visual Studio and create a new solution.
- Add both projects CSharp.Net6.WinUIIntegrationDemo and CSharp.Net6.WinUIIntegrationDemo (Package) to the solution.
- Mark the CSharp.Net6.WinUIIntegrationDemo (Package) as a startup project.
- Right-click on the CSharp.Net6.WinUIIntegrationDemo (Package) and select Deploy from the context menu.
- Once the deployment process has finished successfully, start the project. The hosting application should show a window containing the WinUI report viewer. By default, the report viewer will try to load the Report Catalog report, located in the {installation-directory}\Report Designer\Examples folder.