Click or drag to resize

PdfHttpSettingsLogDocumentKeyNotFoundException Property

Gets or sets a value indicating whether exceptions thrown by the RAD PDF Middleware, when a document key is missing, should be logged to the Windows Application Log.

Namespace:  RadPdf.Integration
Assembly:  RadPdfStandard (in RadPdfStandard.dll) Version: 4.1.0.0 (4.1.0.0)
Syntax
Copy
public bool LogDocumentKeyNotFoundException { get; set; }

Property Value

Type: Boolean
Remarks

If true, RAD PDF will log exceptions thrown while processing an HTTP request which uses an expired or invalid document key. These exceptions are typically thrown when a document key has expired or is missing, but they can also be thrown if the key references a document which no longer exists. In most cases this is caused by a browser being awakened after sleeping for some time, although it can be a sign of an attack.

The default value is true.

This property has no effect if EnableLogging is false.

Examples
The following example overrides the default PdfIntegrationProvider to create a custom Integration Provider for the web application which enables logging for document keys which are not found.
C#
Copy
using System;
using System.Web;

using RadPdf.Integration;

public class CustomPdfIntegrationProvider : PdfIntegrationProvider
{
    public CustomPdfIntegrationProvider() : base()
    {
        // Enable logging for RadPdfDocumentKeyNotFoundExceptions
        this.HttpSettings.LogDocumentKeyNotFoundException = true;
    }
}
The following Program.cs file registers the above custom Integration Provider. This example assumes that CustomPdfIntegrationProvider is in namespace referenced by your ASP.NET web application.
C#
Copy
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

using RadPdf;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddSession();

// Setup WebApplication
var app = builder.Build();
app.UseStaticFiles();
app.UseRouting();
app.UseSession();
app.UseAuthorization();

// Or however you normally process page requests
app.MapRazorPages();

// Create middleware settings
RadPdfCoreMiddlewareSettings settings = new RadPdfCoreMiddlewareSettings()
{
    // Add SQL Server Connection String, if not using Lite Documents
    // Sample connection string below connects to a SQL Server Express instance on localhost
    // TrustServerCertificate=True is set to avoid a trust exception (e.g. "The certificate chain was issued by an authority that is not trusted.")
    // ConnectionString = @"Server=.\SQLExpress;Database=RadPdf;Trusted_Connection=Yes;TrustServerCertificate=True;",

    // Add License Key
    LicenseKey = "DEMO",

    // Attach the Integration Provider
    IntegrationProvider = new CustomPdfIntegrationProvider()

    // To run RAD PDF without the System Service, add UseService = false
    // If using Lite Documents without the System Service, a LiteStorageProvider must also be implemented
    //UseService = false
};

// Add RAD PDF's middleware to app
app.UseRadPdf(settings);

app.Run();
See Also