PrintHelper Class

Provides methods to display a Print Preview for links, grids and reports.

Namespace: DevExpress.Xpf.Printing

Assembly: DevExpress.Xpf.Printing.v17.2.dll

Declaration

C#

public static class PrintHelper

VB.NET

Public Module PrintHelper

Remarks

To create a custom Print Preview window, use the DocumentPreviewWindow class.

Example

This example demonstrates how to use SimpleLink to print data from a non-hierarchical datasource.

To do this, perform the following steps.

• Create a DataTemplate for a single detail row and assign it to the SimpleLink.DetailTemplate property;
• Set the SimpleLink.DetailCount property to the total count of data rows in a data source;
• Handle the SimpleLink.CreateDetail event, and provide data for its CreateAreaEventArgs.Data parameter;
• Call the LinkBase.CreateDocument method to generate report pages.

Note

A complete sample project is available at: https://github.com/DevExpress-Examples/how-to-use-the-simple-link-e1673

Window1.xaml.cs

using System;
using System.Globalization;
using System.Windows;
using DevExpress.Xpf.Printing;
// ...
string[] data;

private void button1_Click(object sender, RoutedEventArgs e) {
    // Create an array of strings.
    data = CultureInfo.CurrentCulture.DateTimeFormat.DayNames;

    // Create a link and specify a template and detail count for it.
    SimpleLink link = new SimpleLink();
    link.DetailTemplate = (DataTemplate)Resources["dayNameTemplate"];
    link.DetailCount = data.Length;

    // Create a document.
    link.CreateDetail += new EventHandler<CreateAreaEventArgs>(link_CreateDetail);

    // Show a Print Preview window.
    PrintHelper.ShowPrintPreviewDialog(this, link);
}

void link_CreateDetail(object sender, CreateAreaEventArgs e) {
    e.Data = data[e.DetailIndex];
}

Window1.xaml.vb

Imports System
Imports System.Globalization
Imports System.Windows
Imports DevExpress.Xpf.Printing
' ...
Private data() As String

Private Sub button1_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    ' Create an array of strings.
    data = CultureInfo.CurrentCulture.DateTimeFormat.DayNames

    ' Create a link and specify a template and detail count for it.
    Dim link As New SimpleLink()
    link.DetailTemplate = DirectCast(Resources("dayNameTemplate"), DataTemplate)
    link.DetailCount = data.Length

    ' Create a document.
    AddHandler link.CreateDetail, AddressOf link_CreateDetail

    ' Show a Print Preview window.
    PrintHelper.ShowPrintPreviewDialog(Me, link)
End Sub

Private Sub link_CreateDetail(ByVal sender As Object, ByVal e As CreateAreaEventArgs)
    e.Data = data(e.DetailIndex)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PrintHelper 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-select-print-templates-based-on-custom-logic-e2369/CS/DXPivotGrid_SelectingPrintTemplate/MainWindow.xaml.cs#L15

private void btnPrint_Click(object sender, RoutedEventArgs e) {
    PrintHelper.ShowPrintPreview(this, picotGridControl1);
}

how-to-print-a-detail-grid-with-a-header-t166273/CS/PrintingDetailHeaderExample/MainWindow.xaml.cs#L33

    PrintableControlLink printLink = new PrintableControlLink(masterGrid.View as TableView, "New Document");
    PrintHelper.ShowPrintPreviewDialog(this, printLink, "New Document");
}

how-to-create-a-scheduler-report-and-show-it-in-the-print-preview-dialog-e3964/CS/SchedulerPrintPreviewSample/MainWindow.xaml.cs#L49

    configurator.Configure(printingSettings);
    PrintHelper.ShowPrintPreviewDialog(this, printingSettings.ReportInstance);
}

Reporting_how-to-use-the-composite-link-t249012/CS/CompositeLinkExample/MainWindow.xaml.cs#L20

    CompositeLink compositeLink = new CompositeLink(links);
    PrintHelper.ShowRibbonPrintPreview(this, compositeLink);
}

Reporting_how-to-use-the-simple-link-e1673/CS/Window1.xaml.cs#L32

    // Show a Print Preview window.
    PrintHelper.ShowPrintPreviewDialog(this, link);
}

VB.NET

how-to-select-print-templates-based-on-custom-logic-e2369/VB/DXPivotGrid_SelectingPrintTemplate/MainWindow.xaml.vb#L17

Private Sub btnPrint_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    PrintHelper.ShowPrintPreview(Me, picotGridControl1)
End Sub

how-to-print-a-detail-grid-with-a-header-t166273/VB/PrintingDetailHeaderExample/MainWindow.xaml.vb#L31

    Dim printLink As New PrintableControlLink(TryCast(masterGrid.View, TableView), "New Document")
    PrintHelper.ShowPrintPreviewDialog(Me, printLink, "New Document")
End Sub

how-to-create-a-scheduler-report-and-show-it-in-the-print-preview-dialog-e3964/VB/SchedulerPrintPreviewSample/MainWindow.xaml.vb#L47

    configurator.Configure(printingSettings)
    PrintHelper.ShowPrintPreviewDialog(Me, printingSettings.ReportInstance)
End Sub

Reporting_how-to-use-the-composite-link-t249012/VB/CompositeLinkExample/MainWindow.xaml.vb#L25

    Dim compositeLink As New CompositeLink(links)
    PrintHelper.ShowRibbonPrintPreview(Me, compositeLink)
End Sub

Reporting_how-to-use-the-simple-link-e1673/VB/Window1.xaml.vb#L34

    ' Show a Print Preview window.
    PrintHelper.ShowPrintPreviewDialog(Me, link)
End Sub

Inheritance

Object

PrintHelper