PivotGridControl.ShowPrintPreview() Method

Opens the Print Preview window with a toolbar-based interface.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public void ShowPrintPreview()

VB.NET

Public Sub ShowPrintPreview

Remarks

The Preview window displays the pivot grid as it will appear when it is printed. Pivot Grid Control can be previewed and printed if the XtraPrinting Library is available. To ensure that printing and previewing Pivot Grid Control is allowed, use the PivotGridControl.IsPrintingAvailable property.

To open the Print Preview window with a Ribbon-based interface, use the PivotGridControl.ShowRibbonPrintPreview method.

Example

The following example demonstrates how to print the Pivot Grid control using the PivotGridControl.Print method and show its Print Preview window using the PivotGridControl.ShowPrintPreview method.

Note

Printing functionality depends on the DevExpress.XtraPrinting library. To verify that the library is available, use the PivotGridControl.IsPrintingAvailable property.

You can access print settings and modify them using the PivotGridControl.OptionsPrint property.

C#

using DevExpress.XtraPivotGrid;
// ...

private void ShowPivotGridPreview(PivotGridControl pivotGrid) {
    // Verify that the Pivot Grid Control can be printed.
    if (!pivotGrid.IsPrintingAvailable) {
        MessageBox.Show("Missing DevExpress.XtraPrinting library", "Error");
        return;
    }
    pivotGrid.ShowPrintPreview();
}

private void PrintPivotGrid(PivotGridControl pivotGrid) {
    // Verify that the Pivot Grid Control can be printed.
    if (!pivotGrid.IsPrintingAvailable) {
        MessageBox.Show("Missing DevExpress.XtraPrinting library", "Error");
        return;
    }
    pivotGrid.Print();
});
}

VB.NET

Imports DevExpress.XtraPivotGrid
' ...

Sub ShowPivotGridPreview(ByVal pivotGrid As PivotGridControl)
   ' Verify that the Pivot Grid Control can be printed.
   If Not pivotGrid.IsPrintingAvailable Then
        MessageBox.Show("Missing DevExpress.XtraPrinting library", "Error");
      Return
   End If
   pivotGrid.ShowPrintPreview()
End Sub

Sub PrintPivotGrid(ByVal pivotGrid As PivotGridControl)
   ' Verify that the Pivot Grid Control can be printed.
   If Not pivotGrid.IsPrintingAvailable Then
        MessageBox.Show("Missing DevExpress.XtraPrinting library", "Error");
      Return
   End If
   pivotGrid.Print()
End Sub

Related GitHub Examples

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

how-to-increase-field-headers-height-and-show-caption-on-two-lines-e3526/CS/WindowsApplication53/Form1.cs#L45

{
    pivotGridControl1.ShowPrintPreview();
}

how-to-change-the-field-header-height-and-show-images-inside-headers-on-screen-and-export-e3162/CS/WindowsApplication53/Form1.cs#L48

    field.Caption = MyPivotGridControl.ImagePlaceHolder + field.Caption;
pivotGridControl1.ShowPrintPreview();
foreach (PivotGridField field in pivotGridControl1.Fields)

VB.NET

how-to-increase-field-headers-height-and-show-caption-on-two-lines-e3526/VB/WindowsApplication53/Form1.vb#L41

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton1.Click
    pivotGridControl1.ShowPrintPreview()
End Sub

how-to-change-the-field-header-height-and-show-images-inside-headers-on-screen-and-export-e3162/VB/WindowsApplication53/Form1.vb#L46

pivotGridControl1.ShowPrintPreview()
For Each field As PivotGridField In pivotGridControl1.Fields