Address Property [Visio 2003 SDK Documentation]

  • Article

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

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.

Version added

5.0

Remarks

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

The Address property value can be a DOS, UNC, or URL path, for example, "driveletter":\"foldername"\"drawingname", \\"servername"\"foldername"\"drawingname", or http://address, respectively.

If the Address property is relative, for example, "..\"drawingname"", 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, 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.

Example

This Microsoft Visual Basic for Applications (VBA) macro sets the Address property of a Hyperlink object. Before running this example, replace address with a valid Internet or intranet address.

Public Sub Address_Example() 

    Dim vsoShape As Visio.Shape 
    Dim vsoHyperlink As Visio.Hyperlink 

    'Create a new shape to receive the hyperlink
    Set vsoShape = ActivePage.DrawRectangle(1, 2, 2, 1) 
    Set vsoHyperlink = vsoShape.AddHyperlink 

    vsoHyperlink.Description = "Web site" 
    vsoHyperlink.Address = "http://address/" 

End Sub

Applies to | Hyperlink object

See Also | ExtraInfo property | Frame property | HyperlinkBase property | SubAddress property