PrintingSystemBase.InsertPageBreak(Single) Method

Inserts a page break at a specified position.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.2.Core.dll

Declaration

C#

public void InsertPageBreak(
    float pos
)

VB.NET

Public Sub InsertPageBreak(
    pos As Single
)

Parameters

Name	Type	Description
pos	Single	A Single value which specified the position to insert a page break.

Remarks

A page break must be inserted between two bricks. The pos parameter value must be the next coordinate value after the lowest coordinate of the brick preceding the page break.

Example

This example demonstrates how to insert a page break between two bricks in a document. To accomplish this task, the PrintingSystemBase.InsertPageBreak method should be used, as demonstrated in the code snippet below.

Note

For this example to work correctly, you should add the PrintingSystem component (named printingSystem1) to your project, prior to executing this code.

The following two images demonstrate a document’s apperance before and after page break insertion.

C#

using System.Drawing;
using DevExpress.XtraPrinting;
// ...

private void button1_Click(object sender, EventArgs e) {
    // Start report generation.
    printingSystem1.Begin();

    // Obtain the Printing System's graphics.
    BrickGraphics gr = printingSystem1.Graph;

    // Specify graphics settings.
    gr.Modifier = BrickModifier.Detail;
    gr.BackColor = Color.FromArgb(26, 26, 154);
    gr.BorderColor = Color.FromArgb(254, 202, 2);

    // Insert a text brick.
    string s = "XtraPrinting Library";
    TextBrick textBrick = new TextBrick();
    textBrick = gr.DrawString(s, Color.FromArgb(67, 145, 252),
        new RectangleF(0, 0, 286, 80), BorderSide.All);
    textBrick.Font = new Font("Arial", 20, FontStyle.Bold | FontStyle.Italic);
    BrickStringFormat bsf = new BrickStringFormat(StringAlignment.Center,
        StringAlignment.Center);
    textBrick.StringFormat = bsf;

    // Insert a page break.
    printingSystem1.InsertPageBreak(81);

    // Insert an image brick.
    Image img = Image.FromFile(@"..\..\Data\logo.png");
    ImageBrick imageBrick = new ImageBrick();
    imageBrick = gr.DrawImage(img, new RectangleF(0, 81, 286, 81));

    // Finish report generation.
    printingSystem1.End();

    // Display the Print Preview form.
    printingSystem1.PreviewFormEx.Show();
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraPrinting
' ...

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) _
Handles button1.Click
    ' Start report generation.
    printingSystem1.Begin()

    ' Obtain the Printing System's graphics.
    Dim gr As BrickGraphics = printingSystem1.Graph

    ' Specify graphics settings.
    gr.Modifier = BrickModifier.Detail
    gr.BackColor = Color.FromArgb(26, 26, 154)
    gr.BorderColor = Color.FromArgb(254, 202, 2)

    ' Insert a text brick.
    Dim s As String = "XtraPrinting Library"
    Dim textBrick As TextBrick = New TextBrick()
    textBrick = gr.DrawString(s, Color.FromArgb(67, 145, 252), _
        New RectangleF(0, 0, 286, 80), BorderSide.All)
    textBrick.Font = New Font("Arial", 20, FontStyle.Bold Or FontStyle.Italic)
    Dim bsf As BrickStringFormat = New BrickStringFormat(StringAlignment.Center, _
        StringAlignment.Center)
    textBrick.StringFormat = bsf

    ' Insert a page break.
    printingSystem1.InsertPageBreak(81)

    ' Insert an image brick.
    Dim img As Image = Image.FromFile("..\..\..\Data\logo.png")
    Dim imageBrick As ImageBrick = New ImageBrick()
    imageBrick = gr.DrawImage(img, New RectangleF(0, 81, 286, 81))

    ' Finish report generation.
    printingSystem1.End()

    ' Display the Print Preview form.
    printingSystem1.PreviewFormEx.Show()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertPageBreak(Single) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-export-grouped-grid-with-page-breaks-between-groups-e1597/VB/WebApplication211/Default.aspx.vb#L50

If i > 0 Then
    self.PrintingSystem.InsertPageBreak(0)
End If

Reporting_how-to-print-multi-frame-images-via-the-xtraprinting-library-e1839/VB/Form1.vb#L98

    ' Add a page break after the image.
    graph.PrintingSystem.InsertPageBreak(Image.Height + 1)
End If

C#

Reporting_how-to-print-multi-frame-images-via-the-xtraprinting-library-e1839/CS/Form1.cs#L88

        // Add a page break after the image.
        graph.PrintingSystem.InsertPageBreak(Image.Height + 1);
}

Implements

InsertPageBreak(Single)