How to: Add a Link to a Page

• Sep 19, 2019
• 2 minutes to read

Important

You need a license to the DevExpress Office File API or DevExpress Universal Subscription to use these examples in production code. Refer to the DevExpress Subscription page for pricing information.

This example shows how to add a link to a page using the PDF Document Creation API.

Note

The measurement unit of X, Y destination coordinates is equal to 1/72 of an inch.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-a-link-to-a-page-t494761

Program.cs

using DevExpress.Pdf;
using System.Drawing;


namespace AddLinkToPage {
    class Program {
        static void Main(string[] args) {
            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {

                // Create an empty document.
                processor.CreateEmptyDocument("..\\..\\Result.pdf");

                // Create and draw graphics.
                using (PdfGraphics graphics = processor.CreateGraphics()) {
                    DrawGraphics(graphics);

                    // Create a link to a page specifying link area, the page number and X, Y destinations.
                    graphics.AddLinkToPage(new RectangleF(180, 160, 480, 30), 1, 168, 230);

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

        static void DrawGraphics(PdfGraphics graphics) {

            // Draw a text line on the page. 
            SolidBrush black = (SolidBrush)Brushes.Black;
            using (Font font = new Font("Times New Roman", 32, FontStyle.Bold)) {
                graphics.DrawString("PDF Document Processor", font, black, 180, 150);
            }
        }
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing


Namespace AddLinkToPage
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Using processor As New PdfDocumentProcessor()

                ' Create an empty document.
                processor.CreateEmptyDocument("..\..\Result.pdf")

                ' Create and draw graphics.
                Using graphics As PdfGraphics = processor.CreateGraphics()
                    DrawGraphics(graphics)

                    ' Create a link to a page specifying link area, the page number and X, Y destinations.
                    graphics.AddLinkToPage(New RectangleF(180, 160, 480, 30), 1, 168, 230)

                    ' Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics)
                End Using
            End Using
        End Sub

        Private Shared Sub DrawGraphics(ByVal graphics As PdfGraphics)

            ' Draw a text line on the page. 
            Dim black As SolidBrush = CType(Brushes.Black, SolidBrush)
            Using font As New Font("Times New Roman", 32, FontStyle.Bold)
                graphics.DrawString("PDF Document Processor", font, black, 180, 150)
            End Using
        End Sub
    End Class
End Namespace