Override Document Preview Commands

• Oct 09, 2023
• 2 minutes to read

This example demonstrates how to override commands available on the WPF Document Preview toolbar. In particular, it shows how to disable the Export to PDF command.

To start with this example, create a new WPF application or open an existing one, and prepare a simple report to display in the Document Preview.

To override a command in the WPF Document Preview, do the following.

1. Create a custom Document Preview object by inheriting from the DocumentPreviewControl class.

2. Override methods that define logic behind the required command. For instance, to customize the Export command, override the Export and CanExport methods as shown in the sample below.

   C#

   using DevExpress.Xpf.Printing;
   using DevExpress.XtraPrinting;
   //...
   
   public class CustomDocumentPreviewControl : DocumentPreviewControl{
       public CustomDocumentPreviewControl() {
       }
   
       public override bool CanExport(DevExpress.XtraPrinting.ExportFormat? format) {
           return format == DevExpress.XtraPrinting.ExportFormat.Pdf ? false : base.CanExport(format);
       }
   
       public override void Export(DevExpress.XtraPrinting.ExportFormat? format) {
           // ...
           base.Export(format);
       }
   }
   

   VB.NET

   Imports DevExpress.Xpf.Printing
   Imports DevExpress.XtraPrinting
   '...
   
   Public Class CustomDocumentPreviewControl
       Inherits DocumentPreviewControl
   
       Public Sub New()
       End Sub
   
       Public Overrides Function CanExport(ByVal format? As DevExpress.XtraPrinting.ExportFormat) As Boolean
           Return If(format = DevExpress.XtraPrinting.ExportFormat.Pdf, False, MyBase.CanExport(format))
       End Function
   
       Public Overrides Sub Export(ByVal format? As DevExpress.XtraPrinting.ExportFormat)
           ' ...
           MyBase.Export(format)
       End Sub
   End Class
   

3. To display the customized Document Preview, create its instance in code. Specify the required Document Preview settings. To display a report, assign it to the DocumentSource property of the custom DocumentPreviewControl.

   C#

   private void ShowPreview_Click(object sender, RoutedEventArgs e) {
       CustomDocumentPreviewControl customPreview = new CustomDocumentPreviewControl();
       XtraReport1 report = new XtraReport1();
       report.CreateDocument();
       customPreview.DocumentSource = report;
       Window newWindow = new Window();
       newWindow.Content = customPreview;
       newWindow.ShowDialog();
   }
   

   VB.NET

   Private Sub ShowPreview_Click(sender As Object, e As RoutedEventArgs)
       Dim customPreview As New CustomDocumentPreviewControl()
       Dim report As New XtraReport1()
       report.CreateDocument()
       customPreview.DocumentSource = report
       Dim newWindow As New Window()
       newWindow.Content = customPreview
       newWindow.ShowDialog()
   End Sub
   

4. Run the application to see the result.

   

Tip

Online Examples:

• Reporting for WPF - Override Export Command in Document Preview
• Reporting for WPF - Override Print and PrintDirect (Quick Print) Commands in Document Preview