←Select platform

PDFInternalLink Structure

Summary

Provides information about the PDF internal link properties

Syntax

C#
VB
Java
C++
[SerializableAttribute()] 
public struct PDFInternalLink 
<SerializableAttribute()> 
Public Structure PDFInternalLink  
   Inherits System.ValueType 
public class PDFInternalLink 
[SerializableAttribute()] 
public value class PDFInternalLink : public System.ValueType  

Remarks

The PDFInternalLink structure contains the properties of a single PDF internal link. An internal link in a PDF file is a location on a page that defines a hot area, when this location is clicked with the mouse. An external viewer should read the properties of the link and proceed to go to the page defined by the properties of the internal link while optionally change the view parameters (zoom factor, fit page mode and scroll position).

The bookmarks and internal links of a PDF has a document (global) scope and are not part of any page. As a result, to read the bookmarks of a document use the PDFDocument.ParseDocumentStructure method and then access the PDFDocument.Bookmarks and PDFDocument.InternalLinks collections.

The internal link has the following properties for the source hot sport:

  • SourcePageNumber: This is the 1-based number of the page where the link is located.

  • SourceBounds: This is the location and size on the source page of the link hot spot. An external viewer may choose to change the mouse cursor shape to a "Hand" when the user hovers over this link and proceed to perform the action of the link when the user clicks the link.

  • BorderWidth: The width of the border of the internal link. An external viewer may choose to frame the source bounds of the link with the width of border specified by this property.

  • BorderColor: The color of the border of the internal link. An external viewer may choose to frame the source bounds of the link with the color of the frame specified by this property.

  • BorderDashLength: The length of dash marks of the border of the internal link. An external viewer may choose to frame the source bounds of the link with the dash length of the frame specified by this property.

The action of an internal link consists of the following:

  • TargetPageNumber: This the 1-based integer to go to. External viewers should scroll to this page when this internal link is activated.

  • TargetPosition: The position in PDF units (1/72 of an inch and bottom-left) of the target page to scroll to. External viewers should scroll to this position when the internal link is activated.

  • TargetZoomPercent: The zoom percent (100 equals to no zoom) of the target page. External viewers should zoom to this value when the internal link is activated

  • TargetPageFitType: The page fit type of the target page. External viewers should set the page view properties based on this value when this internal link is activated.

Example

For an example, refer to PDFDocument.ParseDocumentStructure.

Requirements

Target Platforms

Help Version 20.0.2018.1.18
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Pdf Assembly