Topics
All
Mac OS X
(Only)
Windows
(Only)
Linux
(Only, Not)
iOS
(Only, Not)
Components
Crossplatform Mac & Win
Server (Not)
Client
Old
Guides
Examples
New in version:
6.5
7.0
7.1
7.2
7.3
7.4
7.5
8.0
8.1
8.2
Statistic
DynaPDF.FileLink
Creates a file link annotation.
| Component | Version | macOS | Windows | Server | FileMaker Cloud | FileMaker iOS SDK |
| DynaPDF | 7.2 | Yes | Yes | Yes | Yes | Yes |
MBS( "DynaPDF.FileLink"; PDF; PosX; PosY; Width; Height; FilePath )
Parameters
| Parameter | Description | Example value |
|---|---|---|
| The PDF reference returned from DynaPDF.New. | ||
| PosX | X-Coordinate of bounding rectangle | 100 |
| PosY | Y-Coordinate of bounding rectangle | 100 |
| Width | Width of bounding rectangle | 100 |
| Height | Height of bounding rectangle | 20 |
| FilePath | The file path to use. | "C:\test.pdf" |
Result
Returns number or error.
Description
Creates a file link annotation.A file link annotation opens a file by using the application that is connected with the file extension (MIME type). Viewer applications maybe display a warning before the file is opened.
The file path can be defined as relative or absolute path. However, the usage of an absolute makes only sense if it can be guaranteed that the path exist on an arbitrary system.
If the coordinate system is bottom-up the point PosX, PosY defines the lower left corner of the bounding rectangle. If the coordinate system is top-down it defines the upper left corner.
The border of the link annotation is drawn by using the current line width, stroke color and line dash pattern. If the link should appear without a border set the line width to zero beforehand.
When clicking on a link annotation the rectangle is highlighted, that is a simple visual effect. Several highlight modes are supported, see DynaPDF.SetLinkHighlightMode for further information.
The function does not check whether the path is valid.
If the function succeeds the return value is a annotation handle, a value greater or equal zero. If the function fails it returns an error.
See also FileLink function in DynaPDF manual.
See also
DynaPDF.FileAttachAnnotEx - DynaPDF.FindBookmark
Feedback: Report problem or ask question.
Links
MBS Xojo PDF Plugins
