Share via


Hyperlink Element (Visio XML Reference)

Contains elements for creating multiple jumps between a shape or drawing page and another drawing page, another file, or a Web site.

The Hyperlink element can be added to a shape, page, or document in a ShapeSheet window.

Syntax

<Hyperlink
    [Name]
    [NameU]
    [Del]
    [ID]>
</Hyperlink>

Attributes

Name

Optional string. The name of the element.

NameU

Optional string. The universal name of the element.

Del

Optional boolean. A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally.

ID

Optional int. The unique ID of the element within its parent element.

Element properties

Property

Value

Name

Hyperlink

Minimum Occurrences

0

Maximum Occurrences

Unbounded

Element information

Parent elements

PageSheet

Shape

StyleSheet

DocumentSheet

Child elements

Description

Address

SubAddress

ExtraInfo

Frame

NewWindow

Default

Invisible

SortKey

The Name , NameU , and ID elements are optional; however, at least one is required for each Hyperlink element.

The Hyperlink element is relevant only when contained in a DocumentSheet , PageSheet , or Shape element. It is ignored when contained in a StyleSheet element.

Example

In the following example, the Address element contains the URL for the Visio section of the Microsoft Office Developer Center on MSDN. Because a shape can have multiple hyperlinks, the ID attribute is used to indicate which hyperlink belongs to this URL.

See also

Hyperlinks section