PrintableComponentLink.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.v23.2.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.Printing

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 PrintableComponentLink.CreateDocument method hasn’t been called for it), then calling the ShowPreviewDialog method 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 PrintableComponentLink.CreateDocument method, if required.

For more information, refer to Document Viewer and Document Viewer Toolbars.

Related GitHub Examples

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

VB.NET

word-document-api-invoke-print-preview-dialog/VB/RichEditDocumentServer-Printing/Form1.vb#L49

    link.CreateDocument()
    link.ShowPreviewDialog()
End Using