ChartControl.ShowPrintPreview() Method

Invokes the Print Preview Form, which shows the print preview of the chart.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.UI.dll

Declaration

C#

public void ShowPrintPreview()

VB.NET

Public Sub ShowPrintPreview

Remarks

The Print Preview form displays the chart as it will appear when printed. To print the chart, use the ChartControl.Print method and to export it, use the appropriate ExportTo~ method (e.g. ChartControl.ExportToHtml, ChartControl.ExportToPdf, etc.)

Note

The chart can be previewed, printed or exported only if the XtraPrinting Library is available. To verify this, use the ChartControl.IsPrintingAvailable property.

Example

The following example demonstrates how to print a ChartControl, or show its Print Preview. To do this, you should use either the ChartControl.Print or ChartControl.ShowPrintPreview methods.

Note

A chart can be printed and previewed only if the XtraPrinting Library is available. To verify that printing the chart is possible, use the ChartControl.IsPrintingAvailable property.

When printing a chart, the current print settings will be used to represent a chart. Note that you can access and change these settings via the ChartControl.OptionsPrint property. End-users manually select the printer settings by clicking the Customize toolbar button () in a chart’s preview, and setting the required options in the Printable Component Editor.

C#

using DevExpress.XtraCharts;
// ...

private void ShowChartPreview(ChartControl chart) {
    // Check whether the ChartControl can be previewed.
    if (!chart.IsPrintingAvailable) {
        MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error");
        return;
    }
    // Open the Preview window.
    chart.ShowPrintPreview();
}

private void PrintChart(ChartControl chart) {
    // Check whether the ChartControl can be printed.
    if (!chart.IsPrintingAvailable) {
        MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error");
        return;
    }
    // Print.
    chart.Print();
}

VB.NET

Imports DevExpress.XtraCharts
' ...

Sub ShowChartPreview(ByVal chart As ChartControl)
   ' Check whether the ChartControl can be previewed.
   If Not chart.IsPrintingAvailable Then
      MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error")
      Return
   End If

   ' Opens the Preview window.
   chart.ShowPrintPreview()
End Sub

Sub PrintChart(ByVal chart As ChartControl)
   ' Check whether the ChartControl can be printed.
   If Not chart.IsPrintingAvailable Then
      MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error")
      Return
   End If

   ' Print.
   chart.Print()
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowPrintPreview() method.

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#

winforms-charts-manage-crosshair-cursor-visibility-in-printed-chart/CS/PrintCrosshairSample/Form1.cs#L47

private void OnShowPrintPreviewItemClick(object sender, ItemClickEventArgs e) {
    chartControl.ShowPrintPreview();
}

VB.NET

winforms-charts-manage-crosshair-cursor-visibility-in-printed-chart/VB/PrintCrosshairSample/Form1.vb#L50

Private Sub OnShowPrintPreviewItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs) Handles bbiShowPrintPreview.ItemClick
    chartControl.ShowPrintPreview()
End Sub