Click or drag to resize

PdfHttpSettingsLogDocumentKeyNotFoundException Property

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

Namespace:  RadPdf.Integration
Assembly:  RadPdf (in RadPdf.dll) Version: 3.48.0.0 (3.48.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 web.config file registers the above custom Integration Provider. This example assumes that CustomPdfIntegrationProvider is in the directory App_Code of your ASP.NET web application.
XML
Copy
<?xml version="1.0"?>
<configuration>
  <appSettings>
    <add key="RadPdfConnectionString" value="Server=.\SQLExpress;Database=RadPdf;Trusted_Connection=Yes;"/>
    <add key="RadPdfLicenseKey" value="DEMO"/>
    <add key="RadPdfIntegrationProvider" value="CustomPdfIntegrationProvider,App_Code"/>
  </appSettings>
  <system.web>
    <httpHandlers>
      <add path="RadPdf.axd" verb="GET,POST" type="RadPdf.Web.HttpHandler.PdfHttpHandler"/>
    </httpHandlers>
  </system.web>
  <!--
    The system.webServer element is for use with IIS 7 (and later) when Managed Pipeline Mode is set to "Integrated".
    It will be ignored in other versions of IIS.
    -->
  <system.webServer>
    <validation validateIntegratedModeConfiguration="false"/>
    <handlers>
      <add path="RadPdf.axd" verb="GET,POST" name="PdfHttpHandler" preCondition="integratedMode" type="RadPdf.Web.HttpHandler.PdfHttpHandler"/>
    </handlers>
  </system.webServer>
</configuration>
See Also