Skip to main content
.NET Framework 4.5.2+

PdfGraphics.AddLinkToPage(RectangleF, Int32) Method

Adds a link that refers to the document page with the specified number.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Drawing

Declaration

public void AddLinkToPage(
    RectangleF linkArea,
    int pageNumber
)

Parameters

Name Type Description
linkArea RectangleF

A page area (in world coordinate system) where you can add a link.

pageNumber Int32

The page number.

Remarks

This method specifies the page area on which you can click to refer to the document page defined by the pageNumber parameter.

To draw a link on the PDF page, use one of the following methods:

PdfGraphics.AddToPageForeground, PdfGraphics.AddToPageBackground
These methods allow you to draw content on an existing page.
PdfDocumentProcessor.RenderNewPage
Draws content on a new page.

The code sample below adds a link to the second document page.

View Example

using System;
using DevExpress.Pdf;
using System.Drawing;
//...

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Create an empty document.
    processor.CreateEmptyDocument("..\\..\\Result.pdf");

    // Create and draw graphics.
    using (PdfGraphics graphics = processor.CreateGraphics())
    {
        // Draw a link text.
        SolidBrush black = (SolidBrush)Brushes.Black;
        using (Font font = new Font("Times New Roman", 32, FontStyle.Bold))
        {
            graphics.DrawString("PDF Document API", font, black, 180, 150);
        }

        // Create a link to the second document page.
        graphics.AddLinkToPage(new RectangleF(180, 160, 480, 30), 2);

        // Render a page with graphics.
        processor.RenderNewPage(PdfPaperSize.Letter, graphics);

        // Create the second document page to which the link refers.
        processor.AddNewPage(PdfPaperSize.A4);
    }
}
See Also