Link Class

A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

Inheritance Hierarchy

SystemObject
pdftron.PDF.AnnotsLink

Namespace: pdftron.PDF.Annots
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Link : IClosable, IAnnot

Public NotInheritable Class Link
	Implements IClosable, IAnnot

public ref class Link sealed : IClosable, 
	IAnnot

pdftron.PDF.Annots.Link = function();

Type.createClass(
	'pdftron.PDF.Annots.Link',
	null,
	Windows.Foundation.IClosable,
	pdftron.PDF.IAnnot);

The Link type exposes the following members.

Constructors

	Name	Description
	Link	Creates a Link annotation and initialize it using given Cos/SDF object.

Top

Methods

	Name	Description
	Close
	Create(SDFDoc, Rect)	Creates a new Link annotation.
	Create(SDFDoc, Rect, Action)	Creates a new Link annotation.
	DeleteCustomData	Deletes custom data associated with the given key.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Flatten	Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.
	GetAction	Gets the Action of the Linked Annotation.
	GetAnnotType	Gets the type.
	GetAppearance	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState, String)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetBorderStyle	Gets the border style for the annotation. Typically used for Link annotations.
	GetColorAsCMYK	Gets an annotation's color.
	GetColorAsGray	Gets an annotation's color.
	GetColorAsRGB	Gets the annotation’s active appearance state.
	GetColorCompNum	Gets the color space the annotation's color is represented in.
	GetContents	Gets the contents.
	GetCustomData	Returns custom data associated with the given key.
	GetDate	Gets an annotation's last modified date.
	GetFlag	Gets the flag.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHighlightingMode	Gets the HighlightingMode Linked Annotation.
	GetNormalizedURL	Prepends http:// to a string if it does not contain :// or @. This can be important when passing a url to other APIs that expect a URL Scheme.
	GetOptionalContent	Gets optional content of an annotation.
	GetPage	Gets the page the annotation is associated with.
	GetQuadPoint	Gets the QuadPoint located at a certain index of the QuadPoint Array of the Link annotation.
	GetQuadPointCount	Gets the number of QuadPoints in the QuadPoints Array of the Link annotation.
	GetRect	Gets the rect.
	GetRotation	Gets the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
	GetSDFObj	Gets the SDFObj.
	GetStructParent	Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	GetTriggerAction	Get the Action associated with the selected Annot Trigger event
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUniqueID	Gets the unique ID.
	IsMarkup	Checks if is markup.
	IsValid	Checks if is valid.
	RefreshAppearance	Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
	RefreshAppearance(RefreshOptions)	A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
	RemoveAction	Removes a link annotation's action.
	RemoveAppearance	Removes the annotation's appearance
	RemoveAppearance(AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	RemoveAppearance(AnnotAnnotationState, String)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	Resize	Resize.
	SetAction	Sets the Action of the Linked Annotation. (Optional; PDF 1.1 )
	SetAppearance(Obj)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetAppearance(Obj, AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	SetAppearance(Obj, AnnotAnnotationState, String)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetBorderStyle	Sets the border style for the annotation. Typically used for Link annotations.
	SetColor(ColorPt)	Sets an annotation's color. (Optional; PDF 1.1)
	SetColor(ColorPt, Int32)	Sets an annotation's color. (Optional; PDF 1.1)
	SetContents	Sets the contents.
	SetCustomData	Sets the custom data associated with the specified key.
	SetDate	Sets an annotation's last modified date.
	SetDateToNow	Sets an annotation's modification date and time to the current time. This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
	SetFlag	Sets the value of given Flag.
	SetHighlightingMode	Sets the HighlightingMode Linked Annotation. (Optional; PDF 1.2 )
	SetOptionalContent	Sets optional content of an annotation. (Optional, PDF1.5).
	SetPage	Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
	SetQuadPoint	Set the QuadPoint to be located at a certain index of the QuadPoint Array of the Link annotation. (Optional; PDF 1.6 )
	SetRect	Sets the size and location of an annotation on its page.
	SetRotation	Sets the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
	SetStructParent	Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	SetUniqueID	Sets the unique identifier for this annotation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

pdftron.PDF.Annots Namespace