TreeList.ShowRibbonPrintPreview() Method

Displays the Print Preview window with a Ribbon UI.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v18.2.dll

Declaration

C#

public void ShowRibbonPrintPreview()

VB.NET

Public Sub ShowRibbonPrintPreview

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 Printing Library is available. To check if printing and previewing the control is allowed, use the TreeList.IsPrintingAvailable property.

To display the Print Preview window with a Bars UI, use the TreeList.ShowPrintPreview method.

Example

The following example demonstrates how to print a TreeList with the TreeList.Print method, and show its print preview with the TreeList.ShowRibbonPrintPreview method.

The image below shows the Preview window for a sample Tree List control. The print commands provided by this window are displayed using a Ribbon UI.

C#

using DevExpress.XtraTreeList;
// ...

private void ShowTreeListPreview(TreeList treeList) {
    // Check whether the Tree List can be previewed.
    if (!treeList.IsPrintingAvailable) {
        MessageBox.Show("The Printing Library is not found", "Error");
        return;
    }

    // Open the Preview window.
    treeList.ShowRibbonPrintPreview();
}

private void PrintTreeList(TreeList treeList) {
    // Check whether the Tree List can be printed.
    if (!treeList.IsPrintingAvailable) {
        MessageBox.Show("The Printing Library is not found", "Error");
        return;
    }

    // Print.
    treeList.Print();
}

VB.NET

Imports DevExpress.XtraTreeList
' ...

Sub ShowTreeListPreview(ByVal treeList As TreeList)
   ' Check whether the Tree List can be previewed.
   If Not treeList.IsPrintingAvailable Then
      MessageBox.Show("The Printing Library is not found", "Error")
      Return
   End If

   ' Opens the Preview window.
   treeList.ShowRibbonPrintPreview()
End Sub

Sub PrintTreeList(ByVal treeList As TreeList)
   ' Check whether the Tree List can be printed.
   If Not treeList.IsPrintingAvailable Then
      MessageBox.Show("The Printing Library is not found", "Error")
      Return
   End If

   ' Print.
   treeList.Print()
End Sub