Back to Devexpress

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

wpf-devexpress-dot-xpf-dot-diagram-dot-diagramcontrol-dot-printtopdf-x28-int32-orientationkind-pdfexportoptions-nullable-size-nullable-thickness-boolean-x29.md

latest4.2 KB
Original Source

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.2.dll

NuGet Package : DevExpress.Wpf.Diagram

Declaration

csharp
public void PrintToPdf(
    int pagesCount,
    OrientationKind fitOrientation,
    PdfExportOptions options = null,
    Size? pageSize = null,
    Thickness? pageMargin = null,
    bool showOptionsDialog = true
)
vb
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

NameTypeDescription
pagesCountInt32

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

NameTypeDefaultDescription
optionsPdfExportOptionsnull

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.

See Also

DiagramControl Class

DiagramControl Members

DevExpress.Xpf.Diagram Namespace