GridControl.ShowPrintPreview() Method

Opens the Print Preview window with a Bars UI.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public void ShowPrintPreview()
Public Sub ShowPrintPreview

Remarks

The ShowPrintPreview method shows a print preview of the data displayed by the Grid Control's GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View). The opened print preview window is built using a Bars UI. To display the Print Preview window with a Ribbon UI, use the GridControl.ShowRibbonPrintPreview method.

The grid control can be previewed and printed if the XtraPrinting Library is available. To check if printing and previewing the grid control is allowed, use the GridControl.IsPrintingAvailable property.

To print the data without showing a print preview, use GridControl.Print or GridControl.PrintDialog.

See Printing Overview to learn more.

Examples

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

NOTE

The Grid Control can be printed and previewed only if the XtraPrinting Library is available. To verify that printing the Grid is possible, use the GridControl.IsPrintingAvailable property.

When printing a Grid, the current print settings will be used to represent a Grid. Note that you can access and change these settings via the GridView.OptionsPrint, BandedGridView.OptionsPrint or CardView.OptionsPrint properties.

using DevExpress.XtraGrid;
// ...

private void ShowGridPreview(GridControl grid) {
    // Check whether the GridControl can be previewed.
    if (!grid.IsPrintingAvailable) {
        MessageBox.Show("The 'DevExpress.XtraPrinting' library is not found", "Error");
        return;
    }

    // Open the Preview window.
    grid.ShowPrintPreview();
}

private void PrintGrid(GridControl grid) {
    // Check whether the GridControl can be printed.
    if (!grid.IsPrintingAvailable) {
        MessageBox.Show("The 'DevExpress.XtraPrinting' library is not found", "Error");
        return;
    }

    // Print.
    grid.Print();
}
See Also