Share via


IHlink interface

Note  The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

 

Provides methods that enable a hyperlink to navigate to its target, access a display name for display purposes, and identify itself to its container and frame.

Members

The IHlink interface inherits from the IUnknown interface. IHlink also has these types of members:

  • Methods

Methods

The IHlink interface has these methods.

Method Description
GetAdditionalParams
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 
GetFriendlyName
Note   IHlink::GetFriendlyName may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Gets the display name of the target.

GetHlinkSite
Note   IHlink::GetHlinkSite may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Gets the interface pointer on the site object.

GetMiscStatus
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Gets a value that indicates whether the hyperlink is absolute or relative.

GetMonikerReference
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Gets the moniker portion and the location portion of the target.

GetStringReference
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Gets the name portion and the location portion of the target.

GetTargetFrameName
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Gets the name of the target frame.

Navigate
Note   IHlink::Navigate may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Navigates to the specified target.

SetAdditionalParams
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 
SetFriendlyName
Note   IHlink::SetFriendlyName may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Sets the display name of the target.

SetHlinkSite
Note   IHlink::SetHlinkSite may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Sets the interface pointer on the site object.

SetMonikerReference
Note   IHlink::SetMonikerReference may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Sets the moniker reference of the target.

SetStringReference
Note   IHlink::SetStringReference may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Sets the name portion and the location portion of the target.

SetTargetFrameName
Note   IHlink::SetTargetFrameName may be altered or unavailable in subsequent versions of the operating system or product.
 
Note  The ActiveX Hyperlink API is deprecated in Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.
 

Sets the name of the target frame.

 

Remarks

In Internet Explorer 8 and later, all IHlink interface methods are deprecated except IHlink::GetMonikerReference, IHlink::GetStringReference, ITargetEmbedding::GetTargetFrame, and IHlink::GetMiscStatus.

The IHlink interface enables a Component Object Model (COM) object called a hyperlink to completely encapsulate the behavior of navigating to its target location. Hyperlinks are managed by COM hyperlink container objects, which support the IHlinkSite interface for hyperlinks in the container, and the IHlinkTarget interface for hyperlinks referring to documents or document objects in it.

A document can use the standard Hyperlink object to represent hyperlinks within itself, thus encapsulating the capability of navigating, saving, loading, dragging, dropping, cutting, and pasting hyperlinks. The standard Hyperlink object implements the IHlink interface, the IPersistStream interface, and the IDataObject interface.

The support for IPersistStream means that the Hyperlink object can be saved to a stream or loaded from a stream, and the support for IDataObject means that the object can be cut and pasted.

IHlink interfaces are typically called by an application hyperlink container as part of a user interface for creating new hyperlinks. A standard Hyperlink object can be created through the HlinkCreateFromData function, the HlinkCreateFromMoniker function, the HlinkCreateFromString function, and the OleLoadFromStream function.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Hlink.h

IDL

Hlink.idl

DLL

Hlink.dll