WebDocumentViewerOperationLogger Class

A service enabling you to log events related to processing reports and generated documents by the Web Document Viewer engine.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

Assembly: DevExpress.XtraReports.v19.2.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public class WebDocumentViewerOperationLogger

VB.NET

Public Class WebDocumentViewerOperationLogger

Remarks

The following example illustrates how to use the WebDocumentViewerOperationLogger to restrict exporting a report to any format except PDF. Although the export options available to end-users may be also customized on the client, the server-side approach illustrated below is preferred in some scenarios.

C#

using DevExpress.XtraReports.Web.WebDocumentViewer;
using DevExpress.XtraPrinting;
using System;
// ...

public class MyOperationLogger : WebDocumentViewerOperationLogger {
    public override void ExportDocument(string documentId, string format, ExportOptions options, PrintingSystemBase printingSystem) {
        if (format != "pdf") {
            throw new NotSupportedException(String.Format("Export to {0} format is not allowed!", format.ToUpper()));
        }
         // Specify the default PDF export options.
        options.Pdf.Assign(new PdfExportOptions());
         base.ExportDocument(documentId, format, options, printingSystem);
    }
}

VB.NET

Imports DevExpress.XtraReports.Web.WebDocumentViewer
Imports DevExpress.XtraPrinting
Imports System;
' ...

Public Class MyOperationLogger
    Inherits WebDocumentViewerOperationLogger
    Public Overrides Sub ExportDocument(documentId As String, format As String, options As ExportOptions, printingSystem As PrintingSystemBase)
        If format <> "pdf" Then
            Throw New NotSupportedException([String].Format("Export to {0} format is not allowed!", format.ToUpper()))
        End If
        ' Specify the default PDF export options.
        options.Pdf.Assign(New PdfExportOptions())
        MyBase.ExportDocument(documentId, format, options, printingSystem)
    End Sub
End Class

Register a custom operation logger service at the application startup as shown in the following code snippets:

ASP.NET Web Forms & MVC (CSharp)

using DevExpress.XtraReports.Web.WebDocumentViewer;
// ...

protected void Application_Start(object sender, System.EventArgs e) {
    // ...
    DefaultWebDocumentViewerContainer.RegisterSingleton<WebDocumentViewerOperationLogger, MyOperationLogger>();
}

ASP.NET Web Forms & MVC (VB.NET)

Imports DevExpress.XtraReports.Web.WebDocumentViewer
' ...

Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    DefaultWebDocumentViewerContainer.RegisterSingleton(Of WebDocumentViewerOperationLogger, MyOperationLogger)()
End Sub

ASP.NET Core

public void ConfigureServices(IServiceCollection services) {
    // ...
    services.AddSingleton<WebDocumentViewerOperationLogger, MyOperationLogger>();
}

Tip

To build report documents synchronously (e.g., to access HttpContext values in the XRControl.BeforePrint event handlers of a report), use the WebDocumentViewerOperationLogger.BuildStarting method.

Examples

View Example: Web Document Viewer - How to make the XRPageInfo control display the name of a logged user using the PageInfo.UserName property

View Example: How to implement a custom authorization service

For more information on services, refer to the following help topics:

• Register Services in the Document Viewer (ASP.NET Web Forms)
• Register Services in the Document Viewer (ASP.NET MVC)
• Register Services in the Document Viewer (ASP.NET Core)

Inheritance

Object

WebDocumentViewerOperationLogger