LayoutControl.ShowPrintPreview() Method

Opens the Print Preview window for the LayoutControl with a Bars UI.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public void ShowPrintPreview()

VB.NET

Public Sub ShowPrintPreview

Remarks

The Print Preview window displays the control’s data as it will appear when it is printed. The control can be previewed and printed if the XtraPrinting Library is available. To check if printing and previewing the control is allowed, use the LayoutControl.IsPrintingAvailable property.

To display the Print Preview window with a Ribbon UI, use the LayoutControl.ShowRibbonPrintPreview method.

Example

The following example demonstrates how to print a LayoutControl and show its Print Preivew. The LayoutControl.Print and LayoutControl.ShowPrintPreview methods are called respectively.

C#

using DevExpress.XtraLayout;
// ...

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

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

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

    // Print.
    layout.Print();
}

VB.NET

Imports DevExpress.XtraLayout
' ...

Sub ShowLayoutControlPreview(ByVal layout As LayoutControl)
   ' Check whether the LayoutControl can be previewed.
   If Not layout.IsPrintingAvailable Then
      MessageBox.Show("The 'DevExpress.XtraPrinting' library is not found", "Error")
      Return
   End If

   ' Opens the Preview window.
   layout.ShowPrintPreview()
End Sub

Sub PrintLayoutControl(ByVal layout As LayoutControl
   ' Check whether the LayoutControl can be printed.
   If Not layout.IsPrintingAvailable Then
      MessageBox.Show("The 'DevExpress.XtraPrinting' library is not found", "Error")
      Return
   End If

   ' Print.
   layout.Print()
End Sub