DiagramControl.PrintToPdf(Stream, Int32, Orientation, Nullable<Rect>, PdfExportOptions, Nullable<Size>, Nullable<Thickness>) Method

Exports the diagram to a multi-page PDF document which is sent to the specified stream.

Assembly : DevExpress.Xpf.Diagram.v25.2.dll

NuGet Package : DevExpress.Wpf.Diagram

csharp

public void PrintToPdf(
    Stream stream,
    int pagesCount,
    Orientation fitOrientation,
    Rect? printBounds = null,
    PdfExportOptions options = null,
    Size? pageSize = null,
    Thickness? pageMargin = null
)

Public Sub PrintToPdf(
    stream As Stream,
    pagesCount As Integer,
    fitOrientation As Orientation,
    printBounds As Rect? = Nothing,
    options As PdfExportOptions = Nothing,
    pageSize As Size? = Nothing,
    pageMargin As Thickness? = Nothing
)

Parameters

Name	Type	Description
stream	Stream

A System.IO.Stream object to which the created PDF document should be sent.

| | pagesCount | Int32 |

An integer value that specifies the number of pages to which to fit the diagram.

| | fitOrientation | Orientation |

A System.Windows.Controls.Orientation enumeration value.

Optional Parameters

Name	Type	Default	Description
printBounds	Nullable<Rect>	null

A System.Windows.Rect value that specifies the print bounds.

The options that define how a document is exported.

A System.Windows.Size object specifying the PDF page size.

A System.Windows.Thickness object specifying the PDF page margins.

Remarks

If a method parameter is not specified, the corresponding DiagramControl property value is used. See the table below.

Method Parameter

DiagramControl Property

| | --- | --- | |

options

PdfExportOptions

| |

printBounds

PrintExportMode, PageMargin

| |

pageSize

PageSize

| |

pageMargin

PageMargin

Note

The printing mechanism relies on both pagesCount and fitOrientation parameters in diagram size calculations. If the fitOrientation parameter is Horizontal, the printing mechanism fits the diagram to the specified number of pages horizontally. It uses any number of pages vertically to fit the diagram (and vice versa).

Use the DiagramControl.ExportToPdf method to export the diagram to a single-page PDF document.