BrickGraphics.DrawPageInfo(PageInfo, String, Color, RectangleF, BorderSide) Method

Adds a specific PageInfoBrick to a report.

Namespace: DevExpress.XtraPrinting

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public PageInfoBrick DrawPageInfo(
    PageInfo pageInfo,
    string format,
    Color foreColor,
    RectangleF rect,
    BorderSide sides
)

VB.NET

Public Function DrawPageInfo(
    pageInfo As PageInfo,
    format As String,
    foreColor As Color,
    rect As RectangleF,
    sides As BorderSide
) As PageInfoBrick

Parameters

Name	Type	Description
pageInfo	PageInfo	The type of infomation, displayed in the PageInfoBrick.
format	String	The text to display in the PageInfoBrick.
foreColor	Color	The text color for the added PageInfoBrick.
rect	RectangleF	The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value.
sides	BorderSide	Border settings for the PageInfoBrick.

Returns

Type	Description
PageInfoBrick	The PageInfoBrick added to a report.

Remarks

PageInfoBrick can be created in the page header and page footer areas. The information displayed within the PageInfoBrick depends upon the pageInfo and format parameter values. If the pageInfo parameter value is PageInfo.RomHiNumber or PageInfo.RomLowNumber, the format parameter value is simply ignored and page numbers are displayed using upper or lowercase roman numerals. If the pageInfo parameter value is PageInfo.None, the PageInfoBrick displays a string defined via the format parameter. If the pageInfo parameter value is PageInfo.DateTime, PageInfo.Number or PageInfo.NumberOfTotal, the format parameter value is assumed to be a format string for the information displayed in the PageInfoBrick. For additional information on formatting different value types see the “IFormatProvider Interface” topic in MSDN documentation.

Example

This example demonstrates how to create a PageInfoBrick, used to display information. The first PageInfoBrick displays the current date and time using the FullDateTimePattern. The second brick displays the current page number and the total number of pages in the report.

C#

using DevExpress.XtraPrinting;
// ...

    PageInfoBrick pinfoBrick;
    BrickGraphics brickGraph = printingSystem1.Graph;

    // Start the report generation.
    printingSystem1.Begin();

    // Create a rectangle
    RectangleF rect = new RectangleF(new PointF(0, 0), new SizeF(250, 20));

    // Specify the page header.
    brickGraph.Modifier = BrickModifier.MarginalHeader;

    // Create page info brick to display the current time in full format.
    pinfoBrick = brickGraph.DrawPageInfo(PageInfo.DateTime, "{0:F}" , Color.Black, rect, 
        BorderSide.None);

    // Specify the page footer.
    brickGraph.Modifier = BrickModifier.MarginalFooter;

    // Create page info brick to display page number.
    pinfoBrick = brickGraph.DrawPageInfo(PageInfo.NumberOfTotal, "Page {0} of {1}", 
         Color.Black, rect, BorderSide.None);

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

    // Preview the report.
    printingSystem1.PreviewFormEx.Show();

VB.NET

Imports DevExpress.XtraPrinting
' ...

    Dim pinfoBrick As PageInfoBrick
    Dim brickGraph As BrickGraphics = printingSystem1.Graph

    ' Start the report generation.
    printingSystem1.Begin()

    ' Create a rectangle.
    Dim rect As RectangleF = New RectangleF(New PointF(0, 0), New SizeF(250, 20))

    ' Specify the page header.
    brickGraph.Modifier = BrickModifier.MarginalHeader

    ' Create page info brick to display the current date and time in full format.
    pinfoBrick = brickGraph.DrawPageInfo(PageInfo.DateTime, "{0:F}", Color.Black, rect, _
        BorderSide.None)

    ' Specify the page footer.
    brickGraph.Modifier = BrickModifier.MarginalFooter

    ' Create page info brick to display page number.
    pinfoBrick = brickGraph.DrawPageInfo(PageInfo.NumberOfTotal, "Page {0} of {1}", _
        Color.Black, rect, BorderSide.None)

    ' Finish the report generation.
    printingSystem1.End()

    ' Preview the report.
    printingSystem1.PreviewFormEx.Show()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DrawPageInfo(PageInfo, String, Color, RectangleF, BorderSide) 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.

C#

reporting-printing-library-use-different-brick-types/CS/DifferentBrickTypes/Form1.cs#L135

SizeF size = brickGraphics.MeasureString(devexpress);
pageInfoBrick = brickGraphics.DrawPageInfo(PageInfo.None, devexpress, Color.Black, new RectangleF(new
    PointF(343 - (size.Width - pageImage.Width) / 2, pageImage.Height + 3), size), BorderSide.None);

reporting-printing-library-get-started/CS/Form1.cs#L279

// the current page number from the total number of pages.
PageInfoBrick brick = graph.DrawPageInfo(PageInfo.NumberOfTotal, format, Color.Black, r, BorderSide.None);

reporting-winforms-handle-link-events/CS/UseLinkEvents/Form1.cs#L29

// Draw a page info brick, which displays page numbers.
PageInfoBrick brick = e.Graph.DrawPageInfo(PageInfo.NumberOfTotal, format, Color.Black,
    r, BorderSide.None);

VB.NET

reporting-printing-library-use-different-brick-types/VB/DifferentBrickTypes/Form1.vb#L120

Dim size_Renamed As SizeF = brickGraphics.MeasureString(devexpress)
pageInfoBrick = brickGraphics.DrawPageInfo(PageInfo.None, devexpress, Color.Black, New RectangleF(New PointF(343 - (size_Renamed.Width - pageImage.Width) \ 2, pageImage.Height + 3), size_Renamed), BorderSide.None)
pageInfoBrick.Alignment = BrickAlignment.Center

reporting-printing-library-get-started/VB/Form1.vb#L335

' the current page number from the total number of pages.
Dim brick As PageInfoBrick = graph.DrawPageInfo(PageInfo.NumberOfTotal, _
    format, Color.Black, r, BorderSide.None)

reporting-winforms-handle-link-events/VB/UseLinkEvents/Form1.vb#L33

' Draw a page info brick, which displays page numbers.
Dim brick As PageInfoBrick = e.Graph.DrawPageInfo(PageInfo.NumberOfTotal, format, Color.Black, r, BorderSide.None)

reporting-winforms-create-a-non-printable-brick/VB/Form1.vb#L27

' Create a brick.
Dim brick As PageInfoBrick = graph.DrawPageInfo(PageInfo.NumberOfTotal, format, Color.Black, r, BorderSide.None)
brick.Alignment = BrickAlignment.Far