Address property

Microsoft Visio Developer Reference

Address property

       

Gets or sets the address for a shape's Hyperlink object—the address to which the hyperlink navigates.

Version added

5.0

Syntax

strRet = object.Address
object.Address = stringExpression

strRet

String. The current value of the field.

object

Required. An expression that returns a Hyperlink object.

stringExpression

Required String. The new value for the field.

Remarks

Setting the Address property for a Hyperlink object is equivalent to entering information in the Address box in the Hyperlinks dialog box (click Hyperlinks on the Insert menu), or setting the result of the Address cell in the shape's Hyperlink.Row row through the ShapeSheet window.

The Address property value can be a DOS, UNC, or URL path, for example, c:\Drawings\MyDrawing.vsd, \\Server\Shared\MyDrawing.vsd, or http://www.microsoft.com, respectively.

If the Address property is relative, for example, "..\Drawing.vsd", then it is composed against the HyperlinkBase property, if supplied, or the hyperlink's document path. If the document is not saved, the hyperlink is undefined.

If the Address property is empty, then you can assume the address points to a page in the document that contains the page. In this case, the SubAddress property contains the name of the drawing page to which the hyperlink navigates.