PdfGraphics.AddLinkToUri(RectangleF, Uri) Method

Adds a link to a URI at the specified page rectangle.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.1.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public void AddLinkToUri(
    RectangleF linkArea,
    Uri uri
)

VB.NET

Public Sub AddLinkToUri(
    linkArea As RectangleF,
    uri As Uri
)

Parameters

Name	Type	Description
linkArea	RectangleF	A page area (in the world coordinate system) where you can add a link.
uri	Uri	A Uri object that is the link URI.

Remarks

This method specifies the page area on which you can click to refer to the URI defined by the uri 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 demonstrates how to use the PdfGraphics.AddLinkToUri method to create a link to a URI.

View Example

Program.cs

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

namespace AddLinkToUri
{
    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())
                {
                    using (Font font = new Font("Arial", 34))
                    {
                        SolidBrush blue = (SolidBrush)Brushes.Blue;

                        // Calculate the link size
                        SizeF stringSize = graphics.MeasureString("https://www.devexpress.com", font);
                        RectangleF stringRect = new RectangleF(100, 150, stringSize.Width, stringSize.Height);

                        // Draw a link text. 
                        graphics.DrawString("https://www.devexpress.com", font, blue, stringRect);

                        // Create a link to a URI at the specified page area.
                        graphics.AddLinkToUri(stringRect, new Uri("https://www.devexpress.com"));
                    }

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

        }
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.Drawing

Namespace AddLinkToUri

    Friend Class Program

        Shared Sub Main(ByVal args As String())
            Using processor As PdfDocumentProcessor = New PdfDocumentProcessor()
                ' Create an empty document.
                processor.CreateEmptyDocument("..\..\Result.pdf")
                ' Create and draw graphics.
                Using graphics As PdfGraphics = processor.CreateGraphics()
                    Using font As Font = New Font("Arial", 34)
                        Dim blue As SolidBrush = CType(Brushes.Blue, SolidBrush)
                        ' Calculate the link size
                        Dim stringSize As SizeF = graphics.MeasureString("https://www.devexpress.com", font)
                        Dim stringRect As RectangleF = New RectangleF(100, 150, stringSize.Width, stringSize.Height)
                        ' Draw a link text. 
                        graphics.DrawString("https://www.devexpress.com", font, blue, stringRect)
                        ' Create a link to a URI at the specified page area.
                        graphics.AddLinkToUri(stringRect, New Uri("https://www.devexpress.com"))
                    End Using

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddLinkToUri(RectangleF, Uri) 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-link-to-uri/CS/AddLinkToUri/Program.cs#L19

// Create a link to URI specifying link area and URI.
graphics.AddLinkToUri(new RectangleF(310, 150, 180, 15), new Uri("https://www.devexpress.com"));

VB.NET

pdf-document-api-add-link-to-uri/VB/AddLinkToUri/Program.vb#L17

' Create a link to URI specifying link area and URI.
graphics.AddLinkToUri(New RectangleF(310, 150, 180, 15), New Uri("https://www.devexpress.com"))
' Render a page with graphics.