The requested page is not available for the requested platform. You are viewing the content for Default platform.

Create an ASP.NET Core Angular Application with a Document Viewer

  • 4 min to read

This tutorial describes how to use the DevExpress Template Gallery or .NET Core command line interface (CLI) to generate a basic ASP.NET Core Angular application that contains the HTML5 Document Viewer control.

Tip

See ASP.NET Core Reporting for information about DevExpress Reporting in ASP.NET Core applications.

The Add a New Report to an ASP.NET Core Application tutorial provides instructions on how to add a report to an ASP.NET Core application.

Perform the following steps 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 v19.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 and click Create Project.

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

  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).

    Tip

    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 - Specifies the name of a sample server-side report storage. This storage allows users to open report layout files (REPX) from the Reports folder and instances of report types predefined in the assembly.
    • Log Errors and Events - Specifies whether to use the LoggerService class to log the Document Viewer's server-side errors and events.

    See Create an ASP.NET Core Angular Application with a Report Designer for information on other settings.

    Click Create Project to apply these settings to the project.

  5. Once Visual Studio created an application, right-click the Dependencies | npm folder in the Solution Explorer window and choose Restore Packages (you should run Visual Studio with administrator privileges).

  6. You can specify a report to open in the Document Viewer when the application starts. Navigate to the ClientApp | app | components | report-viewer | report-viewer.ts file and replace the built-in unique report name with your report's name:

    reportUrl: string = "TestReport";
    

    This loads the report with the specified name into the Document Viewer.

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 installation command is finished.

  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. Pass the NuGet Feed URL as the parameter.

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

    Add the --use-logger (or -ul) parameter to log the Document Viewer's server-side errors and events.

    See Create an ASP.NET Core Angular Application with a Report Designer for information on other settings.

  4. Run the commands below to navigate to the created application's folder and download the client resources.

    cd DocumentViewerApp\ClientApp

    npm install

    Tip

    Make sure Node.js 8.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. Use the following commands to restore dependencies, build the application, and get the application's URL:

    cd ..

    dotnet restore

    dotnet run

  6. Open your browser and insert the generated URL to see the result.