Class PdfLinkAnnotation

Namespace

PdfSharp.Pdf.Annotations

Assembly

PdfSharp.dll

Represents a link annotation.

public sealed class PdfLinkAnnotation : PdfAnnotation, ICloneable, IEnumerable<KeyValuePair<string, PdfItem?>>, IEnumerable

Inheritance

object

PdfItem

PdfObject

PdfDictionary

PdfAnnotation

PdfLinkAnnotation

Implements

ICloneable

IEnumerable<KeyValuePair<string, PdfItem>>

IEnumerable

Inherited Members

PdfAnnotation.Delete()

PdfAnnotation.Flags

PdfAnnotation.Parent

PdfAnnotation.Rectangle

PdfAnnotation.Title

PdfAnnotation.Subject

PdfAnnotation.Contents

PdfAnnotation.Color

PdfAnnotation.Opacity

PdfDictionary.Clone()

PdfDictionary.GetEnumerator()

PdfDictionary.ToString()

PdfDictionary.CreateStream(byte[])

PdfDictionary.Elements

PdfDictionary.Stream

PdfObject.Owner

PdfObject.Comment

PdfObject.IsIndirect

PdfObject.Internals

PdfObject.Reference

PdfObject.ReferenceNotNull

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfLinkAnnotation()

Initializes a new instance of the PdfLinkAnnotation class.

public PdfLinkAnnotation()

PdfLinkAnnotation(PdfDocument)

Initializes a new instance of the PdfLinkAnnotation class.

public PdfLinkAnnotation(PdfDocument document)

Parameters

document PdfDocument

Methods

CreateDocumentLink(PdfRectangle, int, XPoint?)

Creates a link within the current document.

public static PdfLinkAnnotation CreateDocumentLink(PdfRectangle rect, int destinationPage, XPoint? point = null)

Parameters

rect PdfRectangle

The link area in default page coordinates.

destinationPage int

The one-based destination page number.

point XPoint?

The position in the destination page.

Returns

PdfLinkAnnotation

CreateDocumentLink(PdfRectangle, string)

Creates a link within the current document using a named destination.

public static PdfLinkAnnotation CreateDocumentLink(PdfRectangle rect, string destinationName)

Parameters

rect PdfRectangle

The link area in default page coordinates.

destinationName string

The named destination’s name.

Returns

PdfLinkAnnotation

CreateDocumentLink(PdfRectangle, string, string, bool?)

Creates a link to an external PDF document using a named destination.

public static PdfLinkAnnotation CreateDocumentLink(PdfRectangle rect, string documentPath, string destinationName, bool? newWindow = null)

Parameters

rect PdfRectangle

The link area in default page coordinates.

documentPath string

The path to the target document.

destinationName string

The named destination’s name in the target document.

newWindow bool?

True, if the destination document shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

PdfLinkAnnotation

CreateEmbeddedDocumentLink(PdfRectangle, string, bool?)

Creates a link to an embedded document.

public static PdfLinkAnnotation CreateEmbeddedDocumentLink(PdfRectangle rect, string destinationPath, bool? newWindow = null)

Parameters

rect PdfRectangle

The link area in default page coordinates.

destinationPath string

The path to the named destination through the embedded documents. The path is separated by '' and the last segment is the name of the named destination. The other segments describe the route from the current (root or embedded) document to the embedded document holding the destination. ".." references to the parent, other strings refer to a child with this name in the EmbeddedFiles name dictionary.

newWindow bool?

True, if the destination document shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

PdfLinkAnnotation

CreateEmbeddedDocumentLink(PdfRectangle, string, string, bool?)

Creates a link to an embedded document in another document.

public static PdfLinkAnnotation CreateEmbeddedDocumentLink(PdfRectangle rect, string documentPath, string destinationPath, bool? newWindow = null)

Parameters

rect PdfRectangle

The link area in default page coordinates.

documentPath string

The path to the target document.

destinationPath string

The path to the named destination through the embedded documents in the target document. The path is separated by '' and the last segment is the name of the named destination. The other segments describe the route from the root document to the embedded document. Each segment name refers to a child with this name in the EmbeddedFiles name dictionary.

newWindow bool?

True, if the destination document shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

PdfLinkAnnotation

CreateFileLink(PdfRectangle, string)

Creates a link to a file.

public static PdfLinkAnnotation CreateFileLink(PdfRectangle rect, string fileName)

Parameters

rect PdfRectangle

fileName string

Returns

PdfLinkAnnotation

CreateWebLink(PdfRectangle, string)

Creates a link to the web.

public static PdfLinkAnnotation CreateWebLink(PdfRectangle rect, string url)

Parameters

rect PdfRectangle

url string

Returns

PdfLinkAnnotation