DiagramControl.PrintToPdf(Int32, OrientationKind, PdfExportOptions, Nullable<Size>, Nullable<Thickness>, Boolean) Method

Exports the diagram to a multi-page PDF file specified by the user in the invoked dialog window.

Namespace: DevExpress.Xpf.Diagram

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

NuGet Package: DevExpress.Wpf.Diagram

Declaration

C#

public void PrintToPdf(
    int pagesCount,
    OrientationKind fitOrientation,
    PdfExportOptions options = null,
    Size? pageSize = null,
    Thickness? pageMargin = null,
    bool showOptionsDialog = true
)

VB.NET

Public Sub PrintToPdf(
    pagesCount As Integer,
    fitOrientation As OrientationKind,
    options As PdfExportOptions = Nothing,
    pageSize As Size? = Nothing,
    pageMargin As Thickness? = Nothing,
    showOptionsDialog As Boolean = True
)

Parameters

Name	Type	Description
pagesCount	Int32	An integer value that specifies the number of pages to which to fit the diagram.
fitOrientation	OrientationKind	A System.Windows.Controls.Orientation enumeration value.

Optional Parameters

Name	Type	Default	Description
options	PdfExportOptions	null	The options that define how a document is exported.
pageSize	Nullable<Size>	null	A System.Windows.Size object specifying the PDF page size.
pageMargin	Nullable<Thickness>	null	A System.Windows.Thickness object specifying the PDF page margins.
showOptionsDialog	Boolean	True	true, to invoke the dialog window which allows the user to change export options; otherwise, false.

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.