Link.ShowPreviewDialog() Method

Invokes the Print Preview Form which modally shows the print preview of the document for this link.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.XtraPrinting.v19.2.dll

Declaration

C#

public void ShowPreviewDialog()

VB.NET

Public Sub ShowPreviewDialog

Remarks

Use the ShowPreviewDialog method to invoke the PrintPreviewFormEx form and show the print preview of the document created for this link. Note that if the link’s document hasn’t been created (the Link.CreateDocument method hasn’t been called for it), then calling the ShowPreviewDialog will create it first. Consequently, if a document was created prior to calling the ShowPreviewDialog method, and nothing was changed that may force its re-creation, the ShowPreviewDialog method doesn’t re-create it, so you need to manually call the Link.CreateDocument method, if required.

The image below displays the standard Print Preview form.

Example

This example demonstrates how to create and display a Print Preview for the DataGrid control, via the DataGridLink.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraPrintingLinks;
// ...

private void simpleButton1_Click(object sender, EventArgs e) {
    DataGridLink dgLink = new DataGridLink();
    dgLink.DataGrid = dataGrid1;
    printingSystem1.Links.Add(dgLink);
    dgLink.ShowPreviewDialog();
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraPrintingLinks
' ...

Private Sub simpleButton1_Click(ByVal sender As Object, _ 
ByVal e As EventArgs) Handles simpleButton1.Click
    Dim dgLink As DataGridLink = New DataGridLink()
    dgLink.DataGrid = dataGrid1
    printingSystem1.Links.Add(dgLink)
    dgLink.ShowPreviewDialog()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowPreviewDialog() 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#

Reporting_how-to-create-a-custom-link-e21/CS/Form1.cs#L15

myLink.ListViewControl = listView1;
myLink.ShowPreviewDialog();

Reporting_how-to-specify-a-custom-paper-size-e2462/CS/Form1.cs#L26

    link.ShowPreviewDialog();
}

Reporting_how-to-control-the-size-of-printable-objects-in-the-xtraprinting-library-e317/CS/Form1.cs#L44

    link.ShowPreviewDialog();
}

how-to-fit-the-size-of-a-chart-to-the-page-width-in-the-print-preview-e2031/CS/PrintTheChart/Form1.cs#L23

l.CreateDetailArea += new CreateAreaEventHandler(l_CreateDetailArea);
l.ShowPreviewDialog();
cp.Release();

VB.NET

Reporting_how-to-create-a-custom-link-e21/VB/Form1.vb#L17

myLink.ListViewControl = listView1
myLink.ShowPreviewDialog()

Reporting_how-to-specify-a-custom-paper-size-e2462/VB/Form1.vb#L24

    link.ShowPreviewDialog()
End Sub

Reporting_how-to-control-the-size-of-printable-objects-in-the-xtraprinting-library-e317/VB/Form1.vb#L42

    link.ShowPreviewDialog()
End Sub

how-to-fit-the-size-of-a-chart-to-the-page-width-in-the-print-preview-e2031/VB/PrintTheChart/Form1.vb#L25

AddHandler l.CreateDetailArea, AddressOf l_CreateDetailArea
l.ShowPreviewDialog()
cp.Release()