Skip to content

Commit fc4cb61

Browse files
ritz078ritz078
committed
Add ASP.NET example for PSPDFKit integration
- Introduced a new ASP.NET example project demonstrating the integration of PSPDFKit. - Added essential files including appsettings, Program.cs, and various view files for a complete web application structure. - Implemented a basic layout with a PDF viewer using PSPDFKit, allowing users to open and view PDF documents. - Included necessary configurations for logging and error handling. - Added sample assets including a default PDF document and favicon for demonstration. - Provided detailed instructions in the README for getting started and running the example. - Updated e2e test script to exclude the new ASP.NET example directory.
1 parent b6379ab commit fc4cb61

30 files changed

+1273
-2
lines changed

‎biome.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"examples/angular/.angular/cache/*",
66
"./examples/*/public/*",
77
"./examples/blazor/wasm/wwwroot/css/*",
8-
"./examples/wasm-benchmark/*"
8+
"./examples/wasm-benchmark/*",
9+
"./examples/asp-net/*"
910
],
1011
"ignoreUnknown": true
1112
},

‎examples/asp-net/Controllers/HomeController.cs

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
using System.Diagnostics;
2+
using Microsoft.AspNetCore.Mvc;
3+
using pspdfkit_aspnet_example.Models;
4+
5+
namespace pspdfkit_aspnet_example.Controllers;
6+
7+
public class HomeController : Controller
8+
{
9+
private readonly ILogger<HomeController> _logger;
10+
11+
public HomeController(ILogger<HomeController> logger)
12+
{
13+
_logger = logger;
14+
}
15+
16+
public IActionResult Index()
17+
{
18+
return View();
19+
}
20+
21+
public IActionResult Privacy()
22+
{
23+
return View();
24+
}
25+
26+
[ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
27+
public IActionResult Error()
28+
{
29+
return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
30+
}
31+
}

‎examples/asp-net/LICENSE

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
The PSPDFKit Sample applications are licensed with a modified BSD
2+
license. In plain language: you're allowed to do whatever you wish
3+
with the code, modify, redistribute, embed in your products (free or
4+
commercial), but you must include copyright, terms of usage and
5+
disclaimer as stated in the license.
6+
7+
You will require a commercial PSPDFKit License to run these examples
8+
in non-demo mode. Please refer to [email protected] for details.
9+
10+
Copyright © 2021-2025 PSPDFKit GmbH.
11+
All rights reserved.
12+
13+
Redistribution and use in source or binary forms,
14+
with or without modification, are permitted provided
15+
that the following conditions are met:
16+
17+
- Redistributions of source code must retain the above copyright
18+
notice, this list of conditions and the following disclaimer.
19+
20+
- Redistributions in binary form must reproduce the above copyright
21+
notice, this list of conditions and the following disclaimer in the
22+
documentation and/or other materials provided with the
23+
distribution.
24+
25+
- Redistributions of PSPDFKit Samples must include attribution to
26+
PSPDFKit, either in documentation or other appropriate media.
27+
28+
- Neither the name of the PSPDFKit, PSPDFKit GmbH, nor its developers
29+
may be used to endorse or promote products derived from
30+
this software without specific prior written permission.
31+
32+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36+
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
39+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
40+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
41+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
42+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎examples/asp-net/Models/ErrorViewModel.cs

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
namespace pspdfkit_aspnet_example.Models;
2+
3+
public class ErrorViewModel
4+
{
5+
public string? RequestId { get; set; }
6+
7+
public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
8+
}

‎examples/asp-net/Program.cs

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
var builder = WebApplication.CreateBuilder(args);
2+
3+
// Add services to the container.
4+
builder.Services.AddControllersWithViews();
5+
6+
var app = builder.Build();
7+
8+
// Configure the HTTP request pipeline.
9+
if (!app.Environment.IsDevelopment())
10+
{
11+
app.UseExceptionHandler("/Home/Error");
12+
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
13+
app.UseHsts();
14+
}
15+
16+
app.UseHttpsRedirection();
17+
app.UseStaticFiles();
18+
19+
app.UseRouting();
20+
21+
app.UseAuthorization();
22+
23+
app.MapControllerRoute(
24+
name: "default",
25+
pattern: "{controller=Home}/{action=Index}/{id?}");
26+
27+
app.Run();

‎examples/asp-net/Properties/launchSettings.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"iisSettings": {
3+
"windowsAuthentication": false,
4+
"anonymousAuthentication": true,
5+
"iisExpress": {
6+
"applicationUrl": "http://localhost:58796",
7+
"sslPort": 44312
8+
}
9+
},
10+
"profiles": {
11+
"pspdfkit_aspnet_example": {
12+
"commandName": "Project",
13+
"dotnetRunMessages": true,
14+
"launchBrowser": true,
15+
"applicationUrl": "https://localhost:7088;http://localhost:5100",
16+
"environmentVariables": {
17+
"ASPNETCORE_ENVIRONMENT": "Development"
18+
}
19+
},
20+
"IIS Express": {
21+
"commandName": "IISExpress",
22+
"launchBrowser": true,
23+
"environmentVariables": {
24+
"ASPNETCORE_ENVIRONMENT": "Development"
25+
}
26+
}
27+
}
28+
}

‎examples/asp-net/README.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# PSPDFKit Web Example – ASP.NET
2+
3+
This example shows how to integrate [Nutrient Web SDK](https://www.nutrient.io/web/) into an ASP.NET backend app.
4+
5+
This example demonstrates both Standalone and Server backend.
6+
7+
## Prerequisites
8+
9+
- [.Net 6.0](https://dotnet.microsoft.com/en-us/download)
10+
- A running Nutrient Document Engine (if you wish to use Server backend). Follow the [guide here](https://www.nutrient.io/guides/web/current/server-backed/setting-up-pspdfkit-server/).
11+
12+
## Support, Issues and License Questions
13+
14+
PSPDFKit offers support for customers with an active SDK license via https://www.nutrient.io/support/request/
15+
16+
Are you [evaluating our SDK](https://www.nutrient.io/try/)? That's great, we're happy to help out! To make sure this is fast, please use a work email and have someone from your company fill out our sales form: https://www.nutrient.io/sales/
17+
18+
## Getting Started
19+
20+
Clone the repo:
21+
22+
```bash
23+
git clone https://github.com/PSPDFKit/pspdfkit-server-example-asp-net.git
24+
cd pspdfkit-server-example-asp-net
25+
```
26+
27+
If Visual Studio informs you that some packages are missing then click on the "Restore" on the right.
28+
29+
## Standalone
30+
31+
After you have downloaded [Nutrient Web SDK](https://customers.www.nutrient.io/download/web/latest), place the contents of the dist directory in `/wwwroot/lib/pspdfkit/`.
32+
33+
Make sure your `/wwwroot/lib/pspdfkit/` folder contains the file `pspdfkit.js` and a `pspdfkit-lib` directory with library assets.
34+
35+
You can then build and run the example using `dotnet watch run` from the root folder.
36+
37+
You can also follow along with our [Getting Started guides](https://www.nutrient.io/getting-started/web/?frontend=aspnet&project=new-project&tool=terminal) for ASP.NET.
38+
39+
## Server
40+
41+
The Standalone example does not require a running Nutrient Document Engine but the Server example does.
42+
43+
Follow the [guide here](https://www.nutrient.io/guides/web/current/server-backed/setting-up-pspdfkit-server/) to set up a running Nutrient Document Engine.
44+
45+
Change the server address in `/Views/Shared/_Layout.cshtml` to the address of your Nutrient Document Engine.
46+
47+
Once you have a running server you will need to generate a JWT and place it in `/Views/Home/Index.cshtml`.
48+
49+
Read [this guide](https://www.nutrient.io/guides/web/current/server-backed/client-authentication/) for more information on this topic.
50+
51+
Upload a document to the server if you haven't already. Get the document id and set it in `/Views/Home/Index.cshtml`.
52+
53+
Build the solution and click on the green play icon in the toolbar starting the app and the index page will open in the browser you have specified to launch with.
54+
55+
## License
56+
57+
This software is licensed under a [modified BSD license](LICENSE).
58+
59+
## Contributing
60+
61+
Please ensure
62+
[you have signed our CLA](https://www.nutrient.io/guides/web/current/miscellaneous/contributing/) so that we can
63+
accept your contributions.

‎examples/asp-net/Views/Home/Index.cshtml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
@{
2+
ViewData["Title"] = "Home Page";
3+
}
4+
5+
<div id="pspdfkit" style="width: 100%; height: 100vh;"></div>
6+
7+
<script src="/lib/pspdfkit/pspdfkit.js"></script>
8+
9+
<script>
10+
PSPDFKit.load({
11+
container: "#pspdfkit",
12+
document: "document.pdf",
13+
})
14+
.then(function(instance) {
15+
console.log("PSPDFKit loaded", instance);
16+
})
17+
.catch(function(error) {
18+
console.error(error.message);
19+
});
20+
</script>

‎examples/asp-net/Views/Home/Privacy.cshtml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@{
2+
ViewData["Title"] = "Privacy Policy";
3+
}
4+
<h1>@ViewData["Title"]</h1>
5+
6+
<p>Use this page to detail your site's privacy policy.</p>

‎examples/asp-net/Views/Shared/Error.cshtml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
@model ErrorViewModel
2+
@{
3+
ViewData["Title"] = "Error";
4+
}
5+
6+
<h1 class="text-danger">Error.</h1>
7+
<h2 class="text-danger">An error occurred while processing your request.</h2>
8+
9+
@if (Model.ShowRequestId)
10+
{
11+
<p>
12+
<strong>Request ID:</strong> <code>@Model.RequestId</code>
13+
</p>
14+
}
15+
16+
<h3>Development Mode</h3>
17+
<p>
18+
Swapping to <strong>Development</strong> environment will display more detailed information about the error that occurred.
19+
</p>
20+
<p>
21+
<strong>The Development environment shouldn't be enabled for deployed applications.</strong>
22+
It can result in displaying sensitive information from exceptions to end users.
23+
For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
24+
and restarting the app.
25+
</p>

‎examples/asp-net/Views/Shared/_Layout.cshtml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>@ViewData["Title"] - pspdfkit_aspnet_example</title>
7+
<link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
8+
<link rel="stylesheet" href="~/css/site.css" asp-append-version="true" />
9+
<link rel="stylesheet" href="~/pspdfkit_aspnet_example.styles.css" asp-append-version="true" />
10+
</head>
11+
<body>
12+
13+
@RenderBody()
14+
15+
</body>
16+
</html>

‎examples/asp-net/Views/Shared/_Layout.cshtml.css

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/* Please see documentation at https://docs.microsoft.com/aspnet/core/client-side/bundling-and-minification
2+
for details on configuring this project to bundle and minify static web assets. */
3+
a.navbar-brand {
4+
white-space: normal;
5+
text-align: center;
6+
word-break: break-all;
7+
}
8+
9+
a {
10+
color: #0077cc;
11+
}
12+
13+
.btn-primary {
14+
color: #fff;
15+
background-color: #1b6ec2;
16+
border-color: #1861ac;
17+
}
18+
19+
.nav-pills .nav-link.active,
20+
.nav-pills .show > .nav-link {
21+
color: #fff;
22+
background-color: #1b6ec2;
23+
border-color: #1861ac;
24+
}
25+
26+
.border-top {
27+
border-top: 1px solid #e5e5e5;
28+
}
29+
.border-bottom {
30+
border-bottom: 1px solid #e5e5e5;
31+
}
32+
33+
.box-shadow {
34+
box-shadow: 0 0.25rem 0.75rem rgba(0, 0, 0, 0.05);
35+
}
36+
37+
button.accept-policy {
38+
font-size: 1rem;
39+
line-height: inherit;
40+
}
41+
42+
.footer {
43+
position: absolute;
44+
bottom: 0;
45+
width: 100%;
46+
white-space: nowrap;
47+
line-height: 60px;
48+
}

‎examples/asp-net/Views/Shared/_ValidationScriptsPartial.cshtml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<script src="~/lib/jquery-validation/dist/jquery.validate.min.js"></script>
2+
<script src="~/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js"></script>

‎examples/asp-net/Views/_ViewImports.cshtml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@using pspdfkit_aspnet_example
2+
@using pspdfkit_aspnet_example.Models
3+
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

‎examples/asp-net/Views/_ViewStart.cshtml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@{
2+
Layout = "_Layout";
3+
}

‎examples/asp-net/appsettings.Development.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"Logging": {
3+
"LogLevel": {
4+
"Default": "Information",
5+
"Microsoft.AspNetCore": "Warning"
6+
}
7+
}
8+
}

‎examples/asp-net/appsettings.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"Logging": {
3+
"LogLevel": {
4+
"Default": "Information",
5+
"Microsoft.AspNetCore": "Warning"
6+
}
7+
},
8+
"AllowedHosts": "*"
9+
}

‎examples/asp-net/pspdfkit-aspnet-example.csproj

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<Project Sdk="Microsoft.NET.Sdk.Web">
2+
3+
<PropertyGroup>
4+
<TargetFramework>net6.0</TargetFramework>
5+
<Nullable>enable</Nullable>
6+
<ImplicitUsings>enable</ImplicitUsings>
7+
<RootNamespace>pspdfkit_aspnet_example</RootNamespace>
8+
</PropertyGroup>
9+
10+
</Project>

‎examples/asp-net/wwwroot/css/site.css

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
html {
2+
font-size: 14px;
3+
}
4+
5+
@media (min-width: 768px) {
6+
html {
7+
font-size: 16px;
8+
}
9+
}
10+
11+
html {
12+
position: relative;
13+
min-height: 100%;
14+
}
15+
16+
body {
17+
margin-bottom: 60px;
18+
}

‎examples/asp-net/wwwroot/document.pdf

188 KB
Binary file not shown.

‎examples/asp-net/wwwroot/favicon.ico

5.3 KB
Binary file not shown.

‎examples/asp-net/wwwroot/js/site.js

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Please see documentation at https://docs.microsoft.com/aspnet/core/client-side/bundling-and-minification
2+
// for details on configuring this project to bundle and minify static web assets.
3+
4+
// Write your JavaScript code.

0 commit comments

Comments
 (0)