PrintTool.ShowRibbonPreview() Method

Invokes the Ribbon Print Preview form showing the document that is created from a source (report or link) assigned to the PrintTool.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.XtraPrinting.v20.2.dll

Declaration

public void ShowRibbonPreview()
Public Sub ShowRibbonPreview

Remarks

Use the ShowRibbonPreview method to invoke the Print Preview form showing a report document.

PrintPreviewRibbonForm1.png

The ShowRibbonPreview method internally generates a report document, if it is has not yet been created.

If the document has already been created when you call the ShowRibbonPreview method, it will not be re-created. For this reason, if the report has been changed, call the XtraReport.CreateDocument or Link.CreateDocument method prior to calling the ShowRibbonPreview method.

After closing the Print Preview form, it is required to explicitly dispose of the document source (report or link) assigned to the PrintTool.

The options of the Print Preview Form are available via the PrintTool.PreviewRibbonForm property.

Examples

In Windows Forms applications, you can show a document's Print Preview by using the following methods of the ReportPrintTool: PrintTool.ShowRibbonPreview and PrintTool.ShowRibbonPreviewDialog.

This code will work in your application after you create a new report in it (named XtraReport1) and handle the Load event of the application's main form.

using System;
using System.Windows.Forms;
using DevExpress.LookAndFeel;
using DevExpress.XtraReports.UI;
// ...

private void Form1_Load(object sender, EventArgs e) {
    XtraReport1 report = new XtraReport1();

    using (ReportPrintTool printTool = new ReportPrintTool(report)) {
        // Invoke the Ribbon Print Preview form modally, 
        // and load the report document into it.
        printTool.ShowRibbonPreviewDialog();

        // Invoke the Ribbon Print Preview form
        // with the specified look and feel setting.
        printTool.ShowRibbonPreviewDialog(UserLookAndFeel.Default);
    }
}
See Also