WP Get links
WP Get links ( targetObj ) : Collection
| Parameter | Type | Description | |
|---|---|---|---|
| targetObj | Object | → | Range or element or 4D Write Pro document |
| Function result | Collection | ← | Collection of links |
Description
The WP Get links command returns the collection of all links defined in targetObj.
In the targetObj parameter, you can pass:
- a range, or
- an element (table / row / paragraph / body / header / footer / section / subsection / text box), or
- a 4D Write Pro document
Returned value
WP Get links returns a collection of link objects, each of them containing one or more of the following properties:
| Property | Type | Description | Available for |
|---|---|---|---|
| [ ].url | Text | Link's target contents | url links |
| [ ].method | Text | Link's method name | method links |
| [ ].parameter | Text | Number | User parameter value passed to the link | method links (if used) |
| [ ].bookmark | Text | Bookmark name for the link | bookmark links |
| [ ].range | Object | Range of the link's label. See Range handling commands | all links |
Example
You want to change the color of all url link labels in a 4D Write Pro document:
var $links : Collection
var $link : Object
$links:=WP Get links(myDoc)
For each($link;$links)
If($link.url#Null) //it's a url link
WP SET ATTRIBUTES($link.range;wk text color;"red")
End if
End for each
See also
Blog: Links in 4D Write Pro documents
WP Get formulas
WP SET LINK