DiagramControl.PrintToPdf(Stream, Int32, Orientation, Nullable<RectangleF>, PdfExportOptions, Nullable<SizeF>, Nullable<Padding>) Method

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

Namespace: DevExpress.XtraDiagram

Assembly: DevExpress.XtraDiagram.v25.1.dll

NuGet Package: DevExpress.Win.Diagram

Declaration

C#

public void PrintToPdf(
    Stream stream,
    int pagesCount,
    Orientation fitOrientation,
    RectangleF? printBounds = null,
    PdfExportOptions options = null,
    SizeF? pageSize = null,
    Padding? pageMargin = null
)

VB.NET

Public Sub PrintToPdf(
    stream As Stream,
    pagesCount As Integer,
    fitOrientation As Orientation,
    printBounds As RectangleF? = Nothing,
    options As PdfExportOptions = Nothing,
    pageSize As SizeF? = Nothing,
    pageMargin As Padding? = 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.Forms.Orientation enumeration value.

Optional Parameters

Name	Type	Default	Description
printBounds	Nullable<RectangleF>	null	A System.Drawing.RectangleF value that specifies the print bounds.
options	PdfExportOptions	null	The options that define how a document is exported.
pageSize	Nullable<SizeF>	null	A System.Drawing.SizeF object specifying the PDF page size.
pageMargin	Nullable<Padding>	null	A System.Windows.Forms.Padding object specifying the PDF page margins.

Remarks

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

Method Parameter	DiagramControl Property
options	PdfExportOptions
printBounds	PrintExportMode, PageMargin
pageSize	PageSize
pageMargin	PageMargin

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

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).