Create an Angular Application with a Document Viewer From Template

  • 4 minutes to read

This document describes how to use the DevExpress Template Gallery or .NET Core command line interface (CLI) to generate a Single-Page Application (SPA) with an ASP.NET Core project that works as an API backend and an Angular CLI project that works as a UI and contains the Document Viewer control.

The DevExpress Template Gallery implements a step-by-step process that allows you to create an ASP.NET Core application with a Document Viewer.

The created application includes a sample report storage that allows users to open report layout files (REPX) from the Reports folder and instances of report types predefined in the assembly.

Follow the steps below to create an ASP.NET Core application in Visual Studio:

  1. Select FILE | New | Project in the main menu or press CTRL+SHIFT+N to create a new project.

    create-new-application-windows-forms

  2. Select the Installed | Visual C# | Web category in the invoked New Project dialog and select the DevExpress v20.2 Template Gallery template.

    asp-net-mvc-reports-create-devexpress-template-gallery

    Specify the application name and click OK.

  3. Select Reporting Angular Application from the NET Core category in the invoked DevExpress Template Gallery.

    create-new-aspnet-core-angular-reporting-application-template-gallery

    Select a framework version and click Create Project.

  4. Enable the Add Viewer Page checkbox in the invoked DevExpress ASP.NET MVC Project Wizard to add the Document Viewer to the web application (the report-viewer.html file). You can add a Web Document Viewer and a Report Designer to the application.

    web-reporting-project-wizard-select-viewer

    Use the following Document Viewer settings:

    • Report Storage Name - the server-side report storage's class name.
    • Data Binding Mode - switches between the Expressions and Expressions (Advanced) modes that specify how data is fetched to reports and controls. See Data Binding Modes for more information.

    Click Create Project to apply these settings to the project.

  5. You can configure the Document Viewer to load a report when the application starts. Navigate to the ClientApp | src | app | report-viewer | report-viewer.ts file and replace the built-in report name with the name of your report:

    reportUrl: string = "TestReport";
    

Use the Console

Use the .NET Core command line interface (CLI) to create an ASP.NET Core Reporting application from the console:

  1. Open the console and type the following command to install DevExpress CLI templates:

    dotnet new -i "DevExpress.DotNet.Web.ProjectTemplates"
    

    The console displays the list of templates installed on your machine after the package is installed.

  2. Refer to the https://nuget.devexpress.com/#feed-url page and obtain the NuGet Feed URL. This URL includes your personal feed authorization key and is used to install NuGet packages for the Document Viewer.

  3. Use the command below to create a new project with a Document Viewer.

    dotnet new dx.reporting.angular --nuget-feed https://nuget.devexpress.com/{auth_key}/api --name DocumentViewerApp --add-viewer true
    

    Specify the following command line parameters to customize the project:

    • -nf | --nuget-feed (required) - specifies your personal DevExpress NuGet Feed URL.
    • -f |--framework (optional) - the framework version. Use values netcoreapp2.1 or netcoreapp3.0. The default value is netcoreapp3.0.
    • -av | --add-viewer - specifies whether to create a web page with a Document Viewer. The default value is true.
    • -ul | --use-logger (optional) - specifies whether to log the Report Designer's server-side errors and events. The default value is false.

    See Create an Angular Application with a Report Designer From Template for information on other settings.

  4. Navigate to the created application's folder and download the client resources.

    cd DocumentViewerApp\ClientApp
    npm install
    

    Ensure that Node.js 10.0 or later with the npm package manager is installed on your computer. Use the node -v and npm -v console commands on 64-bit Windows systems to check package versions (check the PATH environment variable's value if a package's version does not match the version you installed, as there may be a conflict between an x86 and x64 package).

  5. Restore dependencies, build the application, and get the application's URL:

    cd ..
    dotnet restore
    dotnet run
    
  6. Open your browser and navigate to the generated URL to see the result.