SubAddress property

Microsoft Visio Developer Reference

SubAddress property

       

Gets or sets the subaddress in a shape's Hyperlink object.

Version added

5.0

Syntax

strRet = object.SubAddress
object.SubAddress = 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 SubAddress property of a shape's Hyperlink object is optional unless the Address property is blank. In this case the SubAddress must contain the name of the drawing page.

Setting a hyperlink's Subaddress property is equivalent to entering information in Sub-address box in the Hyperlinks dialog box (click Hyperlinks on the Insert menu). This is also equivalent to setting the result of the Subaddress cell in the shape's Hyperlink.Row row in the ShapeSheet window.

The SubAddress property for a Hyperlink object specifies a sublocation within the hyperlink's address. For Visio files, this can be a page name. For Microsoft Excel, this can be a worksheet or a range within a worksheet. For HTML pages, this can be a sub-anchor.

The hyperlink address for which a subaddress is being supplied must support subaddress linking.