Hyperlinks

This section describes Microsoft ActiveX Hyperlinking and the interfaces involved in adding hyperlink navigation to your document or application.

Overviews/Tutorials

Hyperlinks

This section provides an overview of hyperlinks, a description of the ActiveX Hyperlinking architecture (including the interfaces required to add hyperlink support to an application), and examples. Applications can choose to support various degrees of integration with the ActiveX Hyperlinking architecture. Where applicable, this document describes how to provide minimal or simple hyperlinking support, and also how to extend this support for more complete hyperlinking integration.

Objects

Hyperlink

This object implements, at a minimum, an IHlink interface and acts as a link to an object at another location (the target).

Hyperlink Browse Context

This object implements an IHlinkBrowseContext interface and maintains the navigation stack.

Hyperlink Target

This object implements an IHlinkTarget interface and supplies information that other hyperlink objects use to navigate to the target.

Interfaces

IEnumHLItem

Not supported.

IExtensionServices

Exposes methods that provide additional information to an HTTP request.

IHlink

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.

IHlinkBrowseContext

Allows a Component Object Model (COM) object to define and manage the browse context for an ActiveX hyperlink application.

IHlinkFrame

Provides methods that allow a browser to insert a hyperlink frame in the navigation process.

IHlinkSite

Provides methods for a hyperlink to retrieve the moniker or the interface on its hyperlink container. The navigation process that resolves a hyperlink uses this information to handle internal hyperlink references (in the same container) and external hyperlink references (to a different container).

IHlinkTarget

Implemented by a hyperlink target to provide hyperlink references to the target contents.

Methods

IEnumHLItem::Clone

Not supported.

IHlinkBrowseContext::Clone

Duplicates a browse context.

IHlinkBrowseContext::Close

Closes the hyperlink browse context.

IHlinkBrowseContext::EnumNavigationStack

Gets an enumerator used to enumerate the contents of the navigation stack.

IHlink::GetAdditionalParams

Not implemented.

IHlinkFrame::GetBrowseContext

Gets the browse context of the hyperlink frame.

IHlinkTarget::GetBrowseContext

Gets the browse context in which the hyperlink target is currently running.

IHlinkBrowseContext::GetBrowseWindowInfo

Gets the browse window information structure associated with this browse context.

IHlink::GetFriendlyName

Gets the display name of the target.

IHlinkTarget::GetFriendlyName

Gets a display name for the given hyperlink location in the target.

IHlinkBrowseContext::GetHlink

Gets a hyperlink from the browse context.

IHlink::GetHlinkSite

Gets the interface pointer on the site object.

IHlink::GetMiscStatus

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

IHlinkSite::GetMoniker

Gets the moniker to the hyperlink target.

IHlinkTarget::GetMoniker

Returns a moniker to the hyperlink target object.

IHlink::GetMonikerReference

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

IHlinkBrowseContext::GetObject

Gets an object that was registered in the browse context under the given name.

IHlink::GetStringReference

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

IHlink::GetTargetFrameName

Gets the name of the target frame.

IHlink::Navigate

Navigates to the specified target.

IHlinkFrame::Navigate

Navigates to the target hyperlink.

IHlinkTarget::Navigate

Navigates to and shows the specified location in the object or document, if the specified location is not visible.

IEnumHLItem::Next

Not supported.

IHlinkFrame::OnNavigate

Notifies the hyperlink frame about a hyperlink navigation.

IHlinkBrowseContext::OnNavigateHlink

Notifies a browse context that a hyperlink has been clicked.

IHlinkSite::OnNavigationComplete

Notifies the hyperlink site that a hyperlink navigation was successful.

IHlinkBrowseContext::QueryHlink

Tests the validity of a hyperlink ID value.

IHlinkSite::QueryService

Gets any service or interface from the hyperlink site object.

IHlinkSite::ReadyToNavigate

Notifies the hyperlink site that the hyperlink navigation is about to occur.

IHlinkBrowseContext::Register

Registers an object in the browse context.

IEnumHLItem::Reset

Not supported.

IHlinkBrowseContext::Revoke

Revokes an object registered in this browse context.

IExtensionServices::SetAdditionalHeaders

Sets additional headers to append to the HTTP request.

IHlink::SetAdditionalParams

Not implemented.

IExtensionServices::SetAuthenticateData

Sets authentication information for the HTTP request.

IHlinkFrame::SetBrowseContext

Sets the browse context of the hyperlink frame.

IHlinkTarget::SetBrowseContext

Sets the current browse context for the hyperlink target.

IHlinkBrowseContext::SetBrowseWindowInfo

Establishes the HLBWINFO structure for this browse context.

IHlinkBrowseContext::SetCurrentHlink

Sets the current hyperlink in this browse context's navigation stack.

IHlink::SetFriendlyName

Sets the display name of the target.

IHlink::SetHlinkSite

Sets the interface pointer on the site object.

IHlinkBrowseContext::SetInitialHlink

Not supported.

IHlink::SetMonikerReference

Sets the moniker reference of the target.

IHlink::SetStringReference

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

IHlink::SetTargetFrameName

Sets the name of the target frame.

IEnumHLItem::Skip

Not supported.

IHlinkBrowseContext::UpdateHlink

Not supported.

IHlinkFrame::UpdateHlink

Updates the hyperlink frame.

Functions

HlinkClone

Not supported.

HlinkCreateBrowseContext

Creates an empty, default instance of the system browse context object.

HlinkCreateExtensionServices

Not supported.

HlinkCreateFromData

Creates a standard hyperlink object from a COM object that supports the IDataObject interface.

HlinkCreateFromMoniker

Creates a new system hyperlink object from a moniker, a location string, and a friendly name string that is used to display the hyperlink.

HlinkCreateFromString

Creates a new hyperlink object from strings that represent the hyperlink target, the location in the target, and a friendly name.

HlinkCreateShortcut

Not supported.

HlinkCreateShortcutFromMoniker

Not supported.

HlinkCreateShortcutFromString

Not supported.

HlinkGetSpecialReference

Gets a string for a given value from the HLSR enumeration.

HlinkGetValueFromParams

Not supported.

HlinkGoBack

Executes a hyperlink jump backward in the navigation stack.

HlinkGoForward

Executes a hyperlink jump forward in the navigation stack.

HlinkIsShortcut

Not supported.

HlinkNavigate

Navigates to a hyperlink, given a hyperlink object and an optional hyperlink frame object.

HlinkNavigateMoniker

Executes a hyperlink jump, that is specified by a moniker, to a new document or object.

HlinkNavigateString

Executes a hyperlink jump, that is specified by a string, to a new document or object.

HlinkNavigateToStringReference

Creates a hyperlink site from strings that represent the hyperlink target, the location in the target, and a friendly name; and then navigates to that site.

HlinkOnNavigate

Notifies a hyperlink browse context and hyperlink frame, if it exists, that a hyperlink target has been navigated to.

HlinkOnRenameDocument

Not supported.

HlinkParseDisplayName

Not supported.

HlinkPreprocessMoniker

Not supported.

HlinkQueryCreateFromData

Determines if a new hyperlink can be created from an IDataObject interface.

HlinkResolveMonikerForData

Not supported.

HlinkResolveShortcut

Not supported.

HlinkResolveShortcutToMoniker

Not supported.

HlinkResolveShortcutToString

Not supported.

HlinkResolveStringForData

Not supported.

HlinkSetSpecialReference

Inserts a string into a specified member of the HLSR enumeration.

HlinkSimpleNavigateToMoniker

Executes a hyperlink jump, specified by a moniker, to a new document or object.

HlinkSimpleNavigateToString

Executes a hyperlink jump to a new document or object.

HlinkTranslateURL

Not supported.

HlinkUpdateStackItem

Not supported.

OleSaveToStreamEx

Not supported.

Structures

HLBWINFO

Contains parameters that provide information about locations and sizes of frame-level and document-level windows within a browse context.

HLITEM

Indicates the data structure used by the system browse context to track hyperlinks.

HLTBINFO

Not supported.

Enumerations

HLBWIF

Contains values relating to the locations and sizes of frame-level and document-level windows within a browse context.

HLFNAMEF

Specifies which friendly name a client is requesting. The flags are used by the IHlink::GetFriendlyName interface.

HLID

Identifies the logical positions of a hyperlink identifier in the hyperlink navigation stack. The constants are used in the IHlinkBrowseContext interface.

HLINKGETREF

Specifies whether the client is requesting the absolute, relative, or default reference for the hyperlink target. The constants are used in the IHlink::GetMonikerReference and IHlink::GetStringReference methods.

HLINKMISC

Specifies whether the hyperlink object is a relative hyperlink to its target. The constants are used in the IHlink::GetMiscStatus method.

HLINKSETF

Specifies the operation of IHlink::SetMonikerReference. It allows a caller of this function to specify which IHlink parameter to set.

HLINKWHICHMK

Specifies whether a moniker being requested is the moniker for the container document or a base moniker specific to a hyperlink site. The constants are used in the IHlinkSite::GetMoniker method.

HLNF

Indicates how hyperlink navigation is to proceed. The enumeration is also used by the objects participating in the navigation protocol to convey to each other contextual information about the navigation.

HLQF

Specifies query flags used by IHlinkBrowseContext::QueryHlink to determine the state of a particular hyperlink.

HLSHORTCUTF

Not supported.

HLSR

Specifies which of the special hyperlink references to choose. The constants are used by the HlinkGetSpecialReference and HlinkSetSpecialReference functions.

HLTB

Not supported.

HLTRANSLATEF

Not supported.