Hyperlink Interface

Definition

Namespace:

Microsoft.Office.Interop.Word

Assembly:

Microsoft.Office.Interop.Word.dll

Represents a hyperlink.

public interface class Hyperlink

[System.Runtime.InteropServices.Guid("0002099D-0000-0000-C000-000000000046")]
public interface Hyperlink

type Hyperlink = interface

Public Interface Hyperlink

Attributes

GuidAttribute

Remarks

The Hyperlink object is a member of the Hyperlinks collection.

Use the Hyperlink property to return a Hyperlink object associated with a shape (a shape can have only one hyperlink).

Use Hyperlinks(index), where index is the index number, to return a single Hyperlink object from a document, range, or selection.

Properties

Address	Returns or sets the address (for example, a file name or URL) of the specified hyperlink.
AddressOld	Reserved for internal use.
Application	Returns an Application object that represents the Microsoft Word application.
Creator	Returns a 32-bit integer that indicates the application in which the specified object was created.
EmailSubject	Returns or sets the text string for the specified hyperlink’s subject line. The subject line is appended to the hyperlink’s Internet address, or URL.
ExtraInfoRequired	True if extra information is required to resolve the specified hyperlink.
Name	Returns or sets the name of the specified object.
Parent	Returns an object that represents the parent object of the specified object.
Range	Returns a Range object that represents the portion of a document that is contained in the specified object.
ScreenTip	Returns or sets the text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
Shape	Returns a Shape object for the specified hyperlink.
SubAddress	Returns or sets a named location in the destination of the specified hyperlink.
SubAddressOld	Reserved for internal use.
Target	Returns or sets the name of the frame or window in which to load the hyperlink.
TextToDisplay	Returns or sets the specified hyperlink's visible text in a document.
Type	Returns the hyperlink type.

Methods

AddToFavorites()	Creates a shortcut to the document or hyperlink and adds it to the Favorites folder.
CreateNewDocument(String, Boolean, Boolean)	Creates a new document linked to the specified hyperlink.
Delete()	Deletes the specified object.
Follow(Object, Object, Object, Object, Object)	Displays a cached document associated with the specified Hyperlink object, if it has already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.