PrintTool Class

The base class for the ReportPrintTool class.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.XtraPrinting.v19.2.dll

Declaration

C#

public class PrintTool :
    PrintToolBase,
    IDisposable

VB.NET

Public Class PrintTool
    Inherits PrintToolBase
    Implements IDisposable

Remarks

The PrintTool class exposes the PrintToolBase.PrintingSystem property that allows you to access a Print Tool’s printing options, and the PrintTool.PreviewForm and PrintTool.PreviewRibbonForm properties that provide access to the options of its Print Preview form.

Example

This example shows how you can print a Windows Forms control (e.g. GridControl) using PrintTool.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-print-a-gridcontrol-using-the-printtool-e2852

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraPrinting;
// ...
private void simpleButton1_Click(object sender, EventArgs e) {
    PrintableComponentLink componentLink = new PrintableComponentLink(new PrintingSystem());
    componentLink.Component = gridControl1;
    componentLink.CreateDocument();
    PrintTool pt = new PrintTool(componentLink.PrintingSystemBase);
    pt.ShowPreviewDialog();
}

Form1.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraPrinting
' ...
Private Sub simpleButton1_Click(ByVal sender As Object, _
ByVal e As EventArgs) Handles simpleButton1.Click
    Dim componentLink As New PrintableComponentLink(New PrintingSystem())
    componentLink.Component = gridControl1
    componentLink.CreateDocument()
    Dim pt As New PrintTool(componentLink.PrintingSystemBase)
    pt.ShowPreviewDialog()
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PrintTool 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#

how-to-use-the-print-preview-dialog-to-adjust-margins-in-the-richeditcontrol-document-e3384/CS/Form1.cs#L59

private void btnShowPrintPreview_Click(object sender, EventArgs e) {
    PrintTool tool = new PrintTool(link.PrintingSystem);
    link.CreateDocument();

VB.NET

how-to-use-the-print-preview-dialog-to-adjust-margins-in-the-richeditcontrol-document-e3384/VB/Form1.vb#L55

Private Sub btnShowPrintPreview_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnShowPrintPreview.Click
    Dim tool As New PrintTool(link.PrintingSystem)
    link.CreateDocument()

Inheritance

Object

PrintToolBase

PrintTool

LinkPrintTool

ReportPrintTool