PdfTextWebLinkAnnotation

12 Sep 20253 minutes to read

PdfTextWebLinkAnnotation class represents the link annotation objects.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Create a new PDF string format
const format: PdfStringFormat = new PdfStringFormat(PdfTextAlignment.left, PdfVerticalAlignment.top);
// Create a new standard font
const font: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 10, PdfFontStyle.regular);
// Get the text size
let size: number[] = font.measureString("Syncfusion Site", format, [0, 0], 0, 0);
// Create a new text web link annotation
let annot: PdfTextWebLinkAnnotation = new PdfTextWebLinkAnnotation(50, 40, size[0], size[1], [0, 0, 0], [165, 42, 42], 1);
// Add annotation to the page
page.annotations.add(annotation);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

author string

Gets the author of the annotation.

border PdfAnnotationBorder

Gets the border of the annotation.

bounds Object

Gets the bounds of the annotation.

caption PdfAnnotationCaption

Gets the caption of the annotation.

color number[]

Gets the fore color of the annotation.

creationDate Date

Gets the creation date of the annotation.

flags PdfAnnotationFlag

Gets the flags of the annotation.

flatten boolean

Gets the boolean flag indicating whether the annotation have been flattened or not.

flattenPopups boolean

Gets the boolean flag indicating whether annotation’s popup have been flattened or not.

font PdfFont

Gets the font of the annotation.

innerColor number[]

Gets the inner color of the annotation.

layer PdfLayer

Gets the PdfLayer of the annotation.

modifiedDate Date

Gets the modification date of the annotation.

name string

Gets the name of the annotation.

opacity number

Gets the opacity of the annotation.

rotate number

Gets the rotation angle of the annotation (Read only).

rotationAngle PdfRotationAngle

Gets the rotation of the annotation.

subject string

Gets the subject of the annotation.

text string

Gets the text of the annotation.

url string

Gets the url of the annotation.

Methods

getValues

Gets the values associated with the specified key.

Parameter	Type	Description
name	string	Key.

Returns string[]

setAppearance

Set the boolean flag to create a new appearance stream for annotations.

Parameter	Type	Description
value	boolean	Set appearance.

Returns void

setValues

Sets the values associated with the specified key.

Parameter	Type	Description
name	string	Key.
value	string	Value associated with the key..

Returns void