Hyperlink Property

A Long type property. Represents the ID (ID property) of the hyperlink, associated with the shape or character block.

Applies to: Character object, Shape object

Syntax

[[Let] hyperlinkIDRet =] object.Hyperlink

[Let] object.Hyperlink = hyperlinkIDSet

The Hyperlink property syntax has these parts:

Part Description
object Required. An expression that returns an object in the Applies to list.
hyperlinkIDRet Optional. A Long type variable.
hyperlinkIDSet Required. An expression that returns a Long value. The ID of the hyperlink.

Remarks

If there's no hyperlink with the ID specified by hyperlinkIDSet, the Hyperlink property doesn't change its value.

The Hyperlink property is also a table parameter of the shape, that is, its value can be described by a formula. To work with Hyperlink as a table parameter, use the CDPT_HYPERLINK constant tag if object is a ConceptDraw shape, or CDPT_CHAR_HYPERLINK if object is a character block.

Example

dim id as Long
' Determine hyperlink ID of ShapeByID(6).Character(1) ' (assume the Shape with ID 6 exists on the page and the shape ' has a Character object, which has a hyperlink) id = thisDoc.ActivePage.ShapeByID(6).Character(1).HyperLink
' Display the Address Property of the hyperlink with the ID obtained above. MsgBox(thisDoc.HyperlinkByID(id).Address)

 

See Also

ID property, HyperlinkByID method, Document object, SetCharHyperlink method