ReportPrintTool Class

An instrument for publishing reports in WinForms applications.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraPrinting.v17.2.dll

Declaration

C#

public class ReportPrintTool :
    PrintTool,
    IReportPrintTool,
    IDisposable

VB.NET

Public Class ReportPrintTool
    Inherits PrintTool
    Implements IReportPrintTool,
               IDisposable

Remarks

Use the ReportPrintTool class, to show a report document in a Print Preview form, or immediately send a report to a printer.

In addition to the properties inherited from its base, the PrintTool class, the ReportPrintTool class exposes the ReportPrintTool.Report property that allows you to access the options of a report assigned to the Report Print Tool.

Note

This class is supposed to be used only in WinForms applications. To publish reports in an ASP.NET application, use the Document Viewer control.

Example

This example illustrates how to define a document scale factor in a print preview.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
using DevExpress.XtraPrinting.Preview;
// ...

private void button1_Click(object sender, EventArgs e) {
    ReportPrintTool printTool = new ReportPrintTool(new XtraReport1());
    printTool.Report.CreateDocument(false);
    printTool.PreviewForm.Load += new EventHandler(PreviewForm_Load);
    printTool.ShowPreviewDialog();
}

void PreviewForm_Load(object sender, EventArgs e) {
    PrintPreviewFormEx frm = (PrintPreviewFormEx)sender;
    frm.PrintingSystem.ExecCommand(PrintingSystemCommand.Scale, new object[] { 0.7f });
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraPrinting.Preview
' ...

Private Sub button1_Click(ByVal sender As Object, _ 
ByVal e As EventArgs) Handles button1.Click
    Dim printTool As New ReportPrintTool(New XtraReport1())
    printTool.Report.CreateDocument(False)
    AddHandler printTool.PreviewForm.Load, AddressOf PreviewForm_Load
    printTool.ShowPreviewDialog()
End Sub

Private Sub PreviewForm_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim frm As PrintPreviewFormEx = CType(sender, PrintPreviewFormEx)
    frm.PrintingSystem.ExecCommand(PrintingSystemCommand.Scale, New Object() { 0.7f })
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ReportPrintTool class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_getting-started-xtrareports-e5144/CS/SalaryReports - Step 02/MainForm.cs#L24

ReportPrintTool printTool = new ReportPrintTool(empReport);
printTool.ShowPreviewDialog();

Reporting_how-to-print-multiple-reports-as-a-single-batch-e1765/CS/BatchPrinting/Form1.cs#L20

ReportPrintTool pt1 = new ReportPrintTool(report1);
pt1.PrintingSystem.StartPrint += new PrintDocumentEventHandler(PrintingSystem_StartPrint);

Reporting_how-to-save-load-a-report-definition-from-a-file-e1279/CS/SaveLoadDefinition/Form1.cs#L31

// Display the print preview.
ReportPrintTool printTool = new ReportPrintTool(report);
printTool.ShowPreviewDialog();

Reporting_how-to-conditionally-hide-detailreportbands-subreports-e271/CS/Form1.cs#L28

    new ReportPrintTool(rp1).ShowPreviewDialog();
}

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/CS/dxSampleGroupSort/SortReportTableHelpers/ReportColumnSortHelper.cs#L19

internal XtraReport Report { get; set; }
internal ReportPrintTool PrintTool { get; set; }

VB.NET

Reporting_getting-started-xtrareports-e5144/VB/SalaryReports - Step 02/MainForm.vb#L22

Dim printTool As New ReportPrintTool(empReport)
printTool.ShowPreviewDialog()

Reporting_how-to-print-multiple-reports-as-a-single-batch-e1765/VB/BatchPrinting/Form1.vb#L25

Dim pt1 As New ReportPrintTool(report1)
AddHandler pt1.PrintingSystem.StartPrint, AddressOf PrintingSystem_StartPrint

Reporting_how-to-save-load-a-report-definition-from-a-file-e1279/VB/SaveLoadDefinition/Form1.vb#L33

' Display the print preview.
Dim printTool As New ReportPrintTool(report)
printTool.ShowPreviewDialog()

Reporting_how-to-conditionally-hide-detailreportbands-subreports-e271/VB/Form1.vb#L25

    CType(New ReportPrintTool(rp1), ReportPrintTool).ShowPreviewDialog()
End Sub

Reporting_how-to-insert-an-extra-page-after-every-report-bookmark-section-t328498/VB/WindowsFormsApplication1/Form1.vb#L71

    Dim report As XtraReport = New XtraReportMain()
    CType(New ReportPrintTool(report), ReportPrintTool).ShowRibbonPreviewDialog()
End Sub

Inheritance

Object

PrintToolBase

PrintTool

ReportPrintTool