GetHyperlinkID Method

Returns the ID of a hyperlink, provided the hyperlink is present in the hyperlink collection of the document.

Applies to: Document object

Syntax

[[Let] hyperlinkIDRet =] object.GetHyperlinkID ( hyperlinkObj )

The GetHyperlinkID method syntax has these parts:

Part Description
object Required. A reference to an instance of the Document object.
hyperlinkObj Required. An expression that returns a Hyperlink type value. Represents the hyperlink, which ID is to be returned.
hyperlinkIDRet Optional. A Long type variable.

Remarks

If the specified hyperlink doesn't exist in the document, the method returns 0.

 

See Also

AddHyperlinkToDocument Method, AddHyperlinkToFile Method, AddHyperlinkToPageShape Method, AddHyperlinkToURL Method, Hyperlink Method, HyperlinkByID Method, HyperlinksNum Method, RemoveUnusedHyperlinks Method, Hyperlink Object, Document Object