Hyperlink
Hyperlink class
Contains elements for creating multiple jumps between a shape or drawing page and another drawing page, another file, or a Web site.
Constructors
| Name | Description |
|---|---|
| Hyperlink | Constructor. |
Properties
| Name | Type | Description |
|---|---|---|
| Name | String | The name of the element. |
| NameU | String | The universal name of the element. |
| ID | int | The unique ID of the element within its parent element. |
| Del | int | A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted loca |
| Description | Str2Value | Description element contains a text string that describes the hyperlink. |
| Address | Str2Value | Specifies a URL address, DOS file name, or UNC path to jump to. |
| SubAddress | Str2Value | Specifies a location within the target document to link to. |
| ExtraInfo | Str2Value | Contains information to be used in resolving a URL, such as the coordinates of an image map. For example, x=41 y=7 would |
| Frame | Str2Value | Contains the name of a frame to target when Microsoft Visio is open as an active document in a container application. Th |
| NewWindow | BoolValue | Specifies whether Microsoft Visio opens a window in a new location when it follows a hyperlink to open a Web page or ano |
| Default | BoolValue | Specifies the default hyperlink for a shape or page. |
| Invisible | BoolValue | Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page. |
| SortKey | Str2Value | Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page. |
Methods
| Name | Description |
|---|---|
| deepClone | Creates deep copy of this instance. |
Hyperlink()
Constructor.
Hyperlink.Name property
The name of the element.
Type: String
Hyperlink.NameU property
The universal name of the element.
Type: String
Hyperlink.ID property
The unique ID of the element within its parent element.
Type: int
Hyperlink.Del property
A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
Type: int
Hyperlink.Description property
Description element contains a text string that describes the hyperlink.
Type: Str2Value
Hyperlink.Address property
Specifies a URL address, DOS file name, or UNC path to jump to.
Type: Str2Value
Hyperlink.SubAddress property
Specifies a location within the target document to link to.
Type: Str2Value
Hyperlink.ExtraInfo property
Contains information to be used in resolving a URL, such as the coordinates of an image map. For example, x=41 y=7 would specify the coordinates of an image map.
Type: Str2Value
Hyperlink.Frame property
Contains the name of a frame to target when Microsoft Visio is open as an active document in a container application. The default is an empty string.
Type: Str2Value
Hyperlink.NewWindow property
Specifies whether Microsoft Visio opens a window in a new location when it follows a hyperlink to open a Web page or another Visio document.
Type: BoolValue
Hyperlink.Default property
Specifies the default hyperlink for a shape or page.
Type: BoolValue
Hyperlink.Invisible property
Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.
Type: BoolValue
Hyperlink.SortKey property
Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.
Type: Str2Value
deepClone()
Creates deep copy of this instance.