Click or drag to resize

DefaultPdfIntegrationProvider Class

Default implementation of PdfIntegrationProvider.
Inheritance Hierarchy
SystemObject
  RadPdf.IntegrationPdfIntegrationProvider
    RadPdf.IntegrationDefaultPdfIntegrationProvider

Namespace:  RadPdf.Integration
Assembly:  RadPdfStandard (in RadPdfStandard.dll) Version: 4.1.0.0 (4.1.0.0)
Syntax
public class DefaultPdfIntegrationProvider : PdfIntegrationProvider

The DefaultPdfIntegrationProvider type exposes the following members.

Constructors
  NameDescription
Public methodDefaultPdfIntegrationProvider
Creates a new instance of the DefaultPdfIntegrationProvider class.
Top
Properties
  NameDescription
Public propertyCode exampleAdvancedSettings
Gets an object that specifies the HTTP settings used with RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleFontResources
Gets an object that specifies the font resources available in RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleHttpSettings
Gets an object that specifies the HTTP settings used with RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleLicense
Gets or sets an object that represents the Red Software issued license currently used by RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleLiteSessionProvider
Gets or sets an object that specifies the session provider used for Lite Documents with RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleLiteStorageProvider
Gets or sets an object that specifies the storage provider used for Lite Documents with RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode examplePdfWebControlResources
Gets or sets a ResourceManager used by the PdfWebControl for visible resources (e.g. text strings used in the interface).
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleStorageProvider
Gets an object that specifies the storage provider used with RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Public propertyCode exampleWcfSettings
Gets an object that specifies the WCF settings used with RAD PDF applications using this integration provider.
(Inherited from PdfIntegrationProvider.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOnDocumentAppending
Called before a document is appended.
(Inherited from PdfIntegrationProvider.)
Public methodOnDocumentCreated
Called after a document is created.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnDocumentDownloading
Called before a document is downloaded.
(Inherited from PdfIntegrationProvider.)
Public methodOnDocumentEmbeddedFileDownloading
Called before an embedded file is download from a document.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnDocumentInit
Called before a document is loaded, as the document interface is initializing.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnDocumentPrinting
Called before a document is printed.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnDocumentSaved
Called after a document is saved.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnDocumentSaving
Called before a document is saved.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnDocumentSearching
Called before a document is searched.
(Inherited from PdfIntegrationProvider.)
Public methodOnDocumentUploading
Called before a document is uploaded into an empty PdfWebControlLite instance.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnHttpHandlerException
Called when an exception occurs in a call to the RAD PDF Middleware.
(Inherited from PdfIntegrationProvider.)
Public methodOnInternalWarning
Called when an internal warning occurs.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleOnObjectDataAdding
Called before an object's data (e.g. the image data for an PdfImageShape object) is added.
(Inherited from PdfIntegrationProvider.)
Public methodOnPageRenderOnDemand
Called before an page is rendered on demand.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleProcessAppendDataRequest
Called when processing a request for object data initiated by the Client API which set the user mode to object insertion with a custom object key.
(Inherited from PdfIntegrationProvider.)
Public methodCode exampleProcessObjectDataRequest
Called when processing a request for object data initiated by the Client API which set the user mode to object insertion with a custom object key.
(Inherited from PdfIntegrationProvider.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
If a custom implementation of PdfIntegrationProvider is not registered in a web application's Program.cs file, DefaultPdfIntegrationProvider is used.
Examples
The following Program.cs file uses the default Integration Provider.
XML
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();

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 Default Integration Provider
    IntegrationProvider = new DefaultPdfIntegrationProvider()

    // 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
};

// Disable logging
settings.IntegrationProvider.EnableLogging = false;

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

app.Run();
See Also