A link annotation represents either a hypertext link to a destination elsewhere in the document or an iText.Kernel.Pdf.Action.PdfAction to be performed. More...

Inheritance diagram for iText.Kernel.Pdf.Annot.PdfLinkAnnotation:

Public Member Functions
	PdfLinkAnnotation (Rectangle rect)
	Creates a new PdfLinkAnnotation instance based on iText.Kernel.Geom.Rectangle instance, that define the location of the annotation on the page in default user space units. More...

override PdfName	GetSubtype ()
	Gets a iText.Kernel.Pdf.PdfName which value is a subtype of this annotation. More...

virtual PdfObject	GetDestinationObject ()
	Gets the annotation destination as iText.Kernel.Pdf.PdfObject instance. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetDestination (PdfObject destination)
	Sets the annotation destination as iText.Kernel.Pdf.PdfObject instance. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetDestination (PdfDestination destination)
	Sets the annotation destination as iText.Kernel.Pdf.Navigation.PdfDestination instance. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	RemoveDestination ()
	Removes the annotation destination. More...

virtual PdfDictionary	GetAction ()
	An iText.Kernel.Pdf.Action.PdfAction to perform, such as launching an application, playing a sound, changing an annotation’s appearance state etc, when the annotation is activated. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetAction (PdfDictionary action)
	Sets a iText.Kernel.Pdf.PdfDictionary representing action to this annotation which will be performed when the annotation is activated. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetAction (PdfAction action)
	Sets a iText.Kernel.Pdf.Action.PdfAction to this annotation which will be performed when the annotation is activated. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	RemoveAction ()
	Removes a iText.Kernel.Pdf.Action.PdfAction from this annotation. More...

virtual PdfName	GetHighlightMode ()
	Gets the annotation highlight mode. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetHighlightMode (PdfName hlMode)
	Sets the annotation highlight mode. More...

virtual PdfDictionary	GetUriActionObject ()
	Gets the annotation URI action as iText.Kernel.Pdf.PdfDictionary. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetUriAction (PdfDictionary action)
	Sets the annotation URI action as iText.Kernel.Pdf.PdfDictionary instance. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetUriAction (PdfAction action)
	Sets the annotation URI action as iText.Kernel.Pdf.Action.PdfAction instance. More...

virtual PdfArray	GetQuadPoints ()
	An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetQuadPoints (PdfArray quadPoints)
	Sets n quadrilaterals in default user space by passing an iText.Kernel.Pdf.PdfArray of 8 × n numbers. More...

virtual PdfDictionary	GetBorderStyle ()
	BS entry specifies a border style dictionary that has more settings than the array specified for the Border entry (see PdfAnnotation.GetBorder() ). More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetBorderStyle (PdfDictionary borderStyle)
	Sets border style dictionary that has more settings than the array specified for the Border entry ( PdfAnnotation.GetBorder() ). More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetBorderStyle (PdfName style)
	Setter for the annotation's preset border style. More...

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation	SetDashPattern (PdfArray dashPattern)
	Setter for the annotation's preset dashed border style. More...

Public Member Functions inherited from iText.Kernel.Pdf.Annot.PdfAnnotation
virtual void	SetLayer (IPdfOCG layer)
	Sets the layer this annotation belongs to. More...

virtual PdfString	GetContents ()
	Gets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetContents (PdfString contents)
	Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetContents (String contents)
	Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...

virtual PdfDictionary	GetPageObject ()
	Gets a iText.Kernel.Pdf.PdfDictionary that represents a page of the document on which annotation is placed, i.e. which has this annotation in it's /Annots array. More...

virtual PdfPage	GetPage ()
	Gets a iText.Kernel.Pdf.PdfPage on which annotation is placed. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetPage (PdfPage page)
	Method that modifies annotation page property, which defines to which page annotation belongs. More...

virtual PdfString	GetName ()
	Gets the annotation name, a text string uniquely identifying it among all the annotations on its page. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetName (PdfString name)
	Sets the annotation name, a text string uniquely identifying it among all the annotations on its page. More...

virtual PdfString	GetDate ()
	The date and time when the annotation was most recently modified. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetDate (PdfString date)
	The date and time when the annotation was most recently modified. More...

virtual int	GetFlags ()
	A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetFlags (int flags)
	Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetFlag (int flag)
	Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	ResetFlag (int flag)
	Resets a flag that specifies a characteristic of the annotation to disabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual bool	HasFlag (int flag)
	Checks if the certain flag that specifies a characteristic of the annotation is in enabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...

virtual PdfDictionary	GetAppearanceDictionary ()
	An appearance dictionary specifying how the annotation shall be presented visually on the page during its interactions with the user (see ISO-320001 12.5.5, "Appearance Streams"). More...

virtual PdfDictionary	GetAppearanceObject (PdfName appearanceType)
	Specific appearance object corresponding to the specific appearance type. More...

virtual PdfDictionary	GetNormalAppearanceObject ()
	The normal appearance is used when the annotation is not interacting with the user. More...

virtual PdfDictionary	GetRolloverAppearanceObject ()
	The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button. More...

virtual PdfDictionary	GetDownAppearanceObject ()
	The down appearance is used when the mouse button is pressed or held down within the annotation’s active area. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetAppearance (PdfName appearanceType, PdfDictionary appearance)
	Sets a specific type of the appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetNormalAppearance (PdfDictionary appearance)
	Sets normal appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetRolloverAppearance (PdfDictionary appearance)
	Sets rollover appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetDownAppearance (PdfDictionary appearance)
	Sets down appearance. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetAppearance (PdfName appearanceType, PdfAnnotationAppearance appearance)
	Sets a specific type of the appearance using PdfAnnotationAppearance wrapper. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetNormalAppearance (PdfAnnotationAppearance appearance)
	Sets normal appearance using PdfAnnotationAppearance wrapper. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetRolloverAppearance (PdfAnnotationAppearance appearance)
	Sets rollover appearance using PdfAnnotationAppearance wrapper. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetDownAppearance (PdfAnnotationAppearance appearance)
	Sets down appearance using PdfAnnotationAppearance wrapper. More...

virtual PdfName	GetAppearanceState ()
	The annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary if there is such. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetAppearanceState (PdfName @as)
	Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary. More...

virtual PdfArray	GetBorder ()
	An array specifying the characteristics of the annotation’s border. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetBorder (PdfAnnotationBorder border)
	Sets the characteristics of the annotation’s border. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetBorder (PdfArray border)
	Sets the characteristics of the annotation’s border. More...

virtual PdfArray	GetColorObject ()
	An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes: The background of the annotation’s icon when closed The title bar of the annotation’s pop-up window The border of a link annotation The number of array elements determines the colour space in which the colour shall be defined: 0 - No colour; transparent 1 - DeviceGray 3 - DeviceRGB 4 - DeviceCMYK More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetColor (PdfArray color)
	Sets an annotation color. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetColor (float[] color)
	Sets an annotation color. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetColor (Color color)
	Sets an annotation color. More...

virtual int	GetStructParentIndex ()
	The integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetStructParentIndex (int structParentIndex)
	Sets he integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetTitle (PdfString title)
	Sets annotation title. More...

virtual PdfString	GetTitle ()
	Annotation title. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetRectangle (PdfArray array)
	The annotation rectangle, defining the location of the annotation on the page in default user space units. More...

virtual PdfArray	GetRectangle ()
	The annotation rectangle, defining the location of the annotation on the page in default user space units. More...

virtual String	GetLang ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetLang (String lang)
	PDF 2.0. More...

virtual PdfName	GetBlendMode ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetBlendMode (PdfName blendMode)
	PDF 2.0. More...

virtual float	GetNonStrokingOpacity ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetNonStrokingOpacity (float nonStrokingOpacity)
	PDF 2.0. More...

virtual float	GetStrokingOpacity ()
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	SetStrokingOpacity (float strokingOpacity)
	PDF 2.0. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	Put (PdfName key, PdfObject value)
	Inserts the value into into the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation and associates it with the specified key. More...

virtual iText.Kernel.Pdf.Annot.PdfAnnotation	Remove (PdfName key)
	Removes the specified key from the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation. More...

virtual void	AddAssociatedFile (PdfFileSpec fs)

virtual PdfArray	GetAssociatedFiles (bool create)
	Returns files associated with PDF annotation. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual bool	IsFlushed ()

Static Public Attributes
static readonly PdfName	None = PdfName.N
	Highlight modes. More...

static readonly PdfName	Invert = PdfName.I

static readonly PdfName	Outline = PdfName.O

static readonly PdfName	Push = PdfName.P

Static Public Attributes inherited from iText.Kernel.Pdf.Annot.PdfAnnotation
const int	INVISIBLE = 1
	Annotation flag. More...

const int	HIDDEN = 2
	Annotation flag. More...

const int	PRINT = 4
	Annotation flag. More...

const int	NO_ZOOM = 8
	Annotation flag. More...

const int	NO_ROTATE = 16
	Annotation flag. More...

const int	NO_VIEW = 32
	Annotation flag. More...

const int	READ_ONLY = 64
	Annotation flag. More...

const int	LOCKED = 128
	Annotation flag. More...

const int	TOGGLE_NO_VIEW = 256
	Annotation flag. More...

const int	LOCKED_CONTENTS = 512
	Annotation flag. More...

static readonly PdfName	HIGHLIGHT_NONE = PdfName.N
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_INVERT = PdfName.I
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_OUTLINE = PdfName.O
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_PUSH = PdfName.P
	Widget annotation highlighting mode. More...

static readonly PdfName	HIGHLIGHT_TOGGLE = PdfName.T
	Widget annotation highlighting mode. More...

static readonly PdfName	STYLE_SOLID = PdfName.S
	Annotation border style. More...

static readonly PdfName	STYLE_DASHED = PdfName.D
	Annotation border style. More...

static readonly PdfName	STYLE_BEVELED = PdfName.B
	Annotation border style. More...

static readonly PdfName	STYLE_INSET = PdfName.I
	Annotation border style. More...

static readonly PdfName	STYLE_UNDERLINE = PdfName.U
	Annotation border style. More...

static readonly PdfString	Marked = new PdfString("Marked")
	Annotation state. More...

static readonly PdfString	Unmarked = new PdfString("Unmarked")
	Annotation state. More...

static readonly PdfString	Accepted = new PdfString("Accepted")
	Annotation state. More...

static readonly PdfString	Rejected = new PdfString("Rejected")
	Annotation state. More...

static readonly PdfString	Canceled = new PdfString("Cancelled")
	Annotation state. More...

static readonly PdfString	Completed = new PdfString("Completed")
	Annotation state. More...

static readonly PdfString	None = new PdfString("None")
	Annotation state. More...

static readonly PdfString	MarkedModel = new PdfString("Marked")
	Annotation state model. More...

static readonly PdfString	ReviewModel = new PdfString("Review")
	Annotation state model. More...

Additional Inherited Members
Static Public Member Functions inherited from iText.Kernel.Pdf.Annot.PdfAnnotation
static iText.Kernel.Pdf.Annot.PdfAnnotation	MakeAnnotation (PdfObject pdfObject)
	Factory method that creates the type specific PdfAnnotation from the given iText.Kernel.Pdf.PdfObject that represents annotation object. More...

Detailed Description

A link annotation represents either a hypertext link to a destination elsewhere in the document or an iText.Kernel.Pdf.Action.PdfAction to be performed.

A link annotation represents either a hypertext link to a destination elsewhere in the document or an iText.Kernel.Pdf.Action.PdfAction to be performed. See also ISO-320001 12.5.6.5, "Link Annotations".

Constructor & Destructor Documentation

◆ PdfLinkAnnotation()

iText.Kernel.Pdf.Annot.PdfLinkAnnotation.PdfLinkAnnotation ( Rectangle rect )

inline

Creates a new PdfLinkAnnotation instance based on iText.Kernel.Geom.Rectangle instance, that define the location of the annotation on the page in default user space units.

Parameters

rect	the iText.Kernel.Geom.Rectangle that define the location of the annotation

Member Function Documentation

◆ GetAction()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetAction ( )

inlinevirtual

An iText.Kernel.Pdf.Action.PdfAction to perform, such as launching an application, playing a sound, changing an annotation’s appearance state etc, when the annotation is activated.

Returns

iText.Kernel.Pdf.PdfDictionary which defines the characteristics and behaviour of an action

◆ GetBorderStyle()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetBorderStyle ( )

inlinevirtual

BS entry specifies a border style dictionary that has more settings than the array specified for the Border entry (see PdfAnnotation.GetBorder() ).

BS entry specifies a border style dictionary that has more settings than the array specified for the Border entry (see PdfAnnotation.GetBorder() ). If an annotation dictionary includes the BS entry, then the Border entry is ignored. If annotation includes AP (see PdfAnnotation.GetAppearanceDictionary() ) it takes precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.

Returns

iText.Kernel.Pdf.PdfDictionary which is a border style dictionary or null if it is not specified.

◆ GetDestinationObject()

virtual PdfObject iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetDestinationObject ( )

inlinevirtual

Gets the annotation destination as iText.Kernel.Pdf.PdfObject instance.

Destination shall be displayed when the annotation is activated. See also ISO-320001, Table 173.

Returns: the annotation destination as iText.Kernel.Pdf.PdfObject instance

◆ GetHighlightMode()

virtual PdfName iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetHighlightMode ( )

inlinevirtual

Gets the annotation highlight mode.

The annotation’s highlighting mode is the visual effect that shall be used when the mouse button is pressed or held down inside its active area. See also ISO-320001, Table 173.

Returns: the name of visual effect

◆ GetQuadPoints()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetQuadPoints ( )

inlinevirtual

An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.

An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. Quadrilaterals are used to define regions inside annotation rectangle in which the link annotation should be activated.

Returns: an iText.Kernel.Pdf.PdfArray of 8 × n numbers specifying the coordinates of n quadrilaterals.

◆ GetSubtype()

override PdfName iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetSubtype ( )

inlinevirtual

Gets a iText.Kernel.Pdf.PdfName which value is a subtype of this annotation.

Gets a iText.Kernel.Pdf.PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.

Returns: subtype of this annotation.

Implements iText.Kernel.Pdf.Annot.PdfAnnotation.

◆ GetUriActionObject()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfLinkAnnotation.GetUriActionObject ( )

inlinevirtual

Gets the annotation URI action as iText.Kernel.Pdf.PdfDictionary.

When Web Capture (see ISO-320001 14.10, “Web Capture”) changes an annotation from a URI to a go-to action, it uses this entry to save the data from the original URI action so that it can be changed back in case the target page for the go-to action is subsequently deleted. See also ISO-320001, Table 173.

Returns: the URI action as pdfDictionary

◆ RemoveAction()

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.RemoveAction ( )

inlinevirtual

Removes a iText.Kernel.Pdf.Action.PdfAction from this annotation.

Returns: this PdfLinkAnnotation instance

◆ RemoveDestination()

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.RemoveDestination ( )

inlinevirtual

Removes the annotation destination.

Destination shall be displayed when the annotation is activated. See also ISO-320001, Table 173.

Returns: this PdfLinkAnnotation instance

◆ SetAction() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetAction ( PdfAction action )

inlinevirtual

Sets a iText.Kernel.Pdf.Action.PdfAction to this annotation which will be performed when the annotation is activated.

Parameters

action

iText.Kernel.Pdf.Action.PdfAction to set to this annotation

Returns: this PdfLinkAnnotation instance

◆ SetAction() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetAction ( PdfDictionary action )

inlinevirtual

Sets a iText.Kernel.Pdf.PdfDictionary representing action to this annotation which will be performed when the annotation is activated.

Parameters

action

iText.Kernel.Pdf.PdfDictionary that represents action to set to this annotation

Returns: this PdfLinkAnnotation instance

◆ SetBorderStyle() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetBorderStyle ( PdfDictionary borderStyle )

inlinevirtual

Sets border style dictionary that has more settings than the array specified for the Border entry ( PdfAnnotation.GetBorder() ).

Sets border style dictionary that has more settings than the array specified for the Border entry ( PdfAnnotation.GetBorder() ). See ISO-320001, Table 166 and GetBorderStyle() for more info.

Parameters

borderStyle a border style dictionary specifying the line width and dash pattern that shall be used in drawing the annotation’s border.

Returns: this PdfLinkAnnotation instance.

◆ SetBorderStyle() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetBorderStyle ( PdfName style )

inlinevirtual

Setter for the annotation's preset border style.

Setter for the annotation's preset border style. Possible values are

PdfAnnotation.STYLE_SOLID
- A solid rectangle surrounding the annotation.
PdfAnnotation.STYLE_DASHED
- A dashed rectangle surrounding the annotation.
PdfAnnotation.STYLE_BEVELED
- A simulated embossed rectangle that appears to be raised above the surface of the page.
PdfAnnotation.STYLE_INSET
- A simulated engraved rectangle that appears to be recessed below the surface of the page.
PdfAnnotation.STYLE_UNDERLINE
- A single line along the bottom of the annotation rectangle.

◆ SetDashPattern()

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetDashPattern ( PdfArray dashPattern )

inlinevirtual

Setter for the annotation's preset dashed border style.

Setter for the annotation's preset dashed border style. This property has affect only if PdfAnnotation.STYLE_DASHED style was used for the annotation border style (see SetBorderStyle(iText.Kernel.Pdf.PdfName). See ISO-320001 8.4.3.6, "Line Dash Pattern" for the format in which dash pattern shall be specified.

Parameters

dashPattern a dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.

Returns: this PdfLinkAnnotation instance.

◆ SetDestination() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetDestination ( PdfDestination destination )

inlinevirtual

Sets the annotation destination as iText.Kernel.Pdf.Navigation.PdfDestination instance.

Destination shall be displayed when the annotation is activated. See also ISO-320001, Table 173.

Parameters

destination the destination to be set as iText.Kernel.Pdf.Navigation.PdfDestination instance

Returns: this PdfLinkAnnotation instance

◆ SetDestination() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetDestination ( PdfObject destination )

inlinevirtual

Sets the annotation destination as iText.Kernel.Pdf.PdfObject instance.

Destination shall be displayed when the annotation is activated. See also ISO-320001, Table 173.

Parameters

destination the destination to be set as iText.Kernel.Pdf.PdfObject instance

Returns: this PdfLinkAnnotation instance

◆ SetHighlightMode()

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetHighlightMode ( PdfName hlMode )

inlinevirtual

Sets the annotation highlight mode.

The annotation’s highlighting mode is the visual effect that shall be used when the mouse button is pressed or held down inside its active area. See also ISO-320001, Table 173.

Parameters

hlMode the name of visual effect to be set

Returns: this PdfLinkAnnotation instance

◆ SetQuadPoints()

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetQuadPoints ( PdfArray quadPoints )

inlinevirtual

Sets n quadrilaterals in default user space by passing an iText.Kernel.Pdf.PdfArray of 8 × n numbers.

Sets n quadrilaterals in default user space by passing an iText.Kernel.Pdf.PdfArray of 8 × n numbers. Quadrilaterals are used to define regions inside annotation rectangle in which the link annotation should be activated.

Parameters

quadPoints an iText.Kernel.Pdf.PdfArray of 8 × n numbers specifying the coordinates of n quadrilaterals.

Returns: this PdfLinkAnnotation instance.

◆ SetUriAction() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetUriAction ( PdfAction action )

inlinevirtual

Sets the annotation URI action as iText.Kernel.Pdf.Action.PdfAction instance.

A URI action (see ISO-320001 12.6.4.7, “URI Actions”) formerly associated with this annotation. When Web Capture (see ISO-320001 14.10, “Web Capture”) changes an annotation from a URI to a go-to action, it uses this entry to save the data from the original URI action so that it can be changed back in case the target page for the go-to action is subsequently deleted. See also ISO-320001, Table 173.

Parameters

action the action to be set

Returns: this PdfLinkAnnotation instance

◆ SetUriAction() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation.SetUriAction ( PdfDictionary action )

inlinevirtual

Sets the annotation URI action as iText.Kernel.Pdf.PdfDictionary instance.

When Web Capture (see ISO-320001 14.10, “Web Capture”) changes an annotation from a URI to a go-to action, it uses this entry to save the data from the original URI action so that it can be changed back in case the target page for the go-to action is subsequently deleted. See also ISO-320001, Table 173.

Parameters

action the action to be set

Returns: this PdfLinkAnnotation instance

Member Data Documentation

◆ None

readonly PdfName iText.Kernel.Pdf.Annot.PdfLinkAnnotation.None = PdfName.N

static

Highlight modes.

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfLinkAnnotation()

Member Function Documentation

◆ GetAction()

◆ GetBorderStyle()

◆ GetDestinationObject()

◆ GetHighlightMode()

◆ GetQuadPoints()

◆ GetSubtype()

◆ GetUriActionObject()

◆ RemoveAction()

◆ RemoveDestination()

◆ SetAction() [1/2]

◆ SetAction() [2/2]

◆ SetBorderStyle() [1/2]

◆ SetBorderStyle() [2/2]

◆ SetDashPattern()

◆ SetDestination() [1/2]

◆ SetDestination() [2/2]

◆ SetHighlightMode()

◆ SetQuadPoints()

◆ SetUriAction() [1/2]

◆ SetUriAction() [2/2]

Member Data Documentation

◆ None