PdfExternalLinkElement Class


PdfExternalLinkElement Class

Represents a link to an external url in a pdf document. When added to a page, it creates a clickable hotspot over the given rectangle that opens the destination url in the reader's default browser.

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfPageElement
SelectPdf.UniversalPdfExternalLinkElement

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public class PdfExternalLinkElement : PdfPageElement

Public Class PdfExternalLinkElement
	Inherits PdfPageElement

The PdfExternalLinkElement type exposes the following members.

Constructors

	Name	Description
	PdfExternalLinkElement(RectangleF, String)	Initializes an external link pdf element.
	PdfExternalLinkElement(Single, Single, Single, Single, String)	Convenience overload — creates the link from explicit x / y / width / height values.

Top

Properties

	Name	Description
	ActualText	Gets or sets the exact text represented by this element (the structure element's /ActualText entry), used when the drawn glyphs do not map to readable text. (Inherited from PdfPageElement)
	AlternateText	Gets or sets the alternate text describing this element for assistive technology (the structure element's /Alt entry). Required on figures for PDF/UA conformance. (Inherited from PdfPageElement)
	Artifact	Gets or sets a value indicating whether this element is an artifact — decorative or layout content that carries no meaning and is excluded from the logical structure (backgrounds, rules, running headers). Takes precedence over TagType. (Inherited from PdfPageElement)
	LinkRectangle	Gets or sets the link rectangle in the pdf page.
	LinkURL	Gets or sets the link destination url.
	TagType	Gets or sets the structure type used to tag this element in a tagged (accessible) document. Ignored unless the document's tagged mode (PdfDocument.Tagged) is enabled. Null (default) leaves the element untagged unless Artifact is set. (Inherited from PdfPageElement)

Top

Example

Copy

PdfDocument document = new PdfDocument();
PdfPage page = document.AddPage();
PdfExternalLinkElement link =
    new PdfExternalLinkElement(20, 20, 200, 20, "https://www.google.com");
page.Add(link);
document.Save("out.pdf");
document.Close();

Dim document As New PdfDocument()
Dim page As PdfPage = document.AddPage()
Dim link As New PdfExternalLinkElement(20, 20, 200, 20, "https://www.google.com")
page.Add(link)
document.Save("out.pdf")
document.Close()

Reference

SelectPdf.Universal Namespace