PdfGraphics.AddToPageForeground(PdfPage, Single, Single) Method

Adds graphics to a PDF page foreground with the specified horizontal and vertical resolutions.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public void AddToPageForeground(
    PdfPage page,
    float dpiX,
    float dpiY
)

VB.NET

Public Sub AddToPageForeground(
    page As PdfPage,
    dpiX As Single,
    dpiY As Single
)

Parameters

Name	Type	Description
page	PdfPage	A PdfPage object that is the page in the document where graphics are drawn (measured in points - 1/72 of an inch).
dpiX	Single	A Single object that represents the value, in dots per inch, for the horizontal resolution.
dpiY	Single	A Single object that represents the value, in dots per inch, for the vertical resolution.

Remarks

Call the AddToPageForeground method to draw graphics as the foreground of the page. To draw graphics as the background of the page content, call the PdfGraphics.AddToPageBackground method.

The overloaded AddToPageForeground method automatically converts world coordinates to page coordinates. See Coordinate Systems to learn more.

The world coordinates (units) are converted to page coordinates (points) using the following formula:

x = (unitX / dpiX) * 72;

y = cropBoxHeight - (unitY / dpiY) * 72.

To render graphics on a PDF document page, pass 72 as a DPI value to this method. The DPI value you pass into this method does not affect graphics quality and is used for coordinates transformation only (world coordinates to page coordinates). For example, the 72 DPI value allows you to transform coordinates without any scaling.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddToPageForeground(PdfPage, Single, 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.

C#

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/CS/CreateGraphics/Program.cs#L38

    graphics.DrawString(text, font, textBrush, bottomRight);
    graphics.AddToPageForeground(page, DrawingDpi, DrawingDpi);
}

pdf-document-api-highlight-search-results/CS/HighlightSearchResults/Program.cs#L52

    }
    graphics.AddToPageForeground(result.Page, 72, 72);
}

pdf-document-api-replace-form-field-with-image/CS/ReplaceFormFieldWithImage/Program.cs#L33

    graphics.AddToPageForeground(page, dpix, dpiY);
}

VB.NET

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/VB/CreateGraphics/Program.vb#L35

    graphics.DrawString(text, font, textBrush, bottomRight)
    graphics.AddToPageForeground(page, DrawingDpi, DrawingDpi)
End Using

pdf-document-api-highlight-search-results/VB/HighlightSearchResults/Program.vb#L43

    graphics.AddToPageForeground(result.Page, 72, 72)
End Using

pdf-document-api-replace-form-field-with-image/VB/ReplaceFormFieldWithImage/Program.vb#L27

    DrawImage(graphics, rect, x, y)
    graphics.AddToPageForeground(page, dpix, dpiY)
End Using