PdfGraphics.AddLinkToPage(RectangleF, Int32, Single, Single) Method
Adds a link to the page with the specified page number and page destination.
Namespace: DevExpress.Pdf
Assembly: DevExpress.Pdf.v19.2.Drawing.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
linkArea | RectangleF | A RectangleF structure that specifies the area on the page where a link is added. |
pageNumber | Int32 | An integer value specifying the page number. |
destinationX | Single | A Single object that is the horizontal coordinate of a page destination where the link is referred to. |
destinationY | Single | A Single object that is the vertical coordinate of a page destination where the link is referred to. |
Example
This example shows how to create a document with graphics and add a hyperlink to a page and URI. To accomplish this task:
- Create an empty document with no pages by calling one of the PdfDocumentProcessor.CreateEmptyDocument overloaded methods.
- Create PDF graphics represented by an instance of the PdfGraphics class by calling the PdfDocumentProcessor.CreateGraphics method. To access PdfGraphics, you need to reference the DevExpress.Pdf.Drawing assembly.
- Draw the graphic content (e.g., an image, a string, lines, polygons) by calling the corresponding Draw method.
- Add a link to the page and to a URI using the PdfGraphics.AddLinkToPage and PdfGraphics.AddLinkToUri methods.
- Render a page with created graphics by calling the PdfDocumentProcessor.RenderNewPage method.
using DevExpress.Pdf;
using System;
using System.Drawing;
namespace DocumentCreationAPI {
class Program {
static void Main(string[] args) {
using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {
// Create an empty document.
processor.CreateEmptyDocument("..\\..\\Result.pdf");
// Create and draw PDF graphics.
using (PdfGraphics graph = processor.CreateGraphics()) {
DrawGraphics(graph);
// Create a link to a page specifying link area, the page number and X, Y destinations.
graph.AddLinkToPage(new Rectangle(180, 160, 480, 30), 1, 168, 230);
// Create a link to URI specifying link area and URI.
graph.AddLinkToUri(new Rectangle(110, 350, 180, 15), new Uri("https://www.devexpress.com"));
// Render a page with graphics.
processor.RenderNewPage(PdfPaperSize.Letter, graph);
}
}
}
static void DrawGraphics(PdfGraphics graph) {
// Draw text lines on the page.
SolidBrush black = (SolidBrush)Brushes.Black;
using (Font font1 = new Font("Times New Roman", 32, FontStyle.Bold)) {
graph.DrawString("PDF Document Processor", font1, black, 180, 150);
}
using (Font font2 = new Font("Arial", 20)) {
graph.DrawString("Display, Print and Export PDF Documents", font2, black, 168, 230);
}
using (Font font3 = new Font("Arial", 10)) {
graph.DrawString("The PDF Document Processor is a non-visual component " +
"that provides the application programming interface of the PDF Viewer.", font3, black, 16, 300);
graph.DrawString("Learn more at", font3, black, 20, 350);
SolidBrush blue = (SolidBrush)Brushes.Blue;
graph.DrawString("https://www.devexpress.com", font3, blue, 110, 350);
}
}
}
}
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddLinkToPage(RectangleF, Int32, 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.