IAccessibleHyperlink Interface Reference

This interface represents hyperlinks. More...

import "AccessibleHyperlink.idl";

Inheritance diagram for IAccessibleHyperlink:

List of all members.

Public Member Functions
HRESULT	anchor ([in] long index,[out, retval] VARIANT *anchor)
	Returns an object that represents the link anchor, as appropriate for the link at the specified index.
HRESULT	anchorTarget ([in] long index,[out, retval] VARIANT *anchorTarget)
	Returns an object representing the target of the link, as appropriate for the link at the specified index.
HRESULT	startIndex ([out, retval] long *index)
	Returns the index at which the textual representation of the hyperlink starts.
HRESULT	endIndex ([out, retval] long *index)
	Returns the index at which the textual rerpesentation of the hyperlink ends.
HRESULT	valid ([out, retval] boolean *valid)
	Returns whether the target object referenced by this link is still valid.

---

Detailed Description

This interface represents hyperlinks.

This interface represents a hyperlink associated with a single substring of text or single non-text object. Non-text objects can have either a single link or a collection of links such as when the non-text object is an image map.

Linked objects and anchors are implementation dependent. This interface is derived from IAccessibleAction. IAccessibleAction::nActions indicates the maximum value for the indices used with the methods of this interface.

Furthermore, the object that implements this interface has to be connected implicitly or explicitly with an object that implements IAccessibleText. IAccessibleHyperlink::startIndex and IAccessibleHyperlink::endIndex are indices with respect to the text exposed by IAccessibleText.

---

Member Function Documentation

HRESULT IAccessibleHyperlink::anchor (  [in] long  index, [out, retval] VARIANT *  anchor )

Returns an object that represents the link anchor, as appropriate for the link at the specified index. Parameters: [in]  index  A 0 based index identifies the anchor when, as in the case of an image map, there is more than one link represented by this object. The valid maximal index is indicated by IAccessibleAction::nActions. [out]  anchor  This is an implementation dependent value. For example, for a text link this method could return the substring of the containing string where the subsgtring is overridden with link behavior, and for an image link this method could return an IUnknown VARIANT for IAccessibleImage.

HRESULT IAccessibleHyperlink::anchorTarget (  [in] long  index, [out, retval] VARIANT *  anchorTarget )

Returns an object representing the target of the link, as appropriate for the link at the specified index. Parameters: [in]  index  A 0 based index identifies the anchor when, as in the case of an image map, there is more than one link represented by this object. The valid maximal index is indicated by IAccessibleAction::nActions. [out]  anchorTarget  This is an implementation dependent value. For example this method could return a BSTR VARIANT of the URI. Alternatively this method could return an IUnknown VARIANT of a COM interface representing a target object to be activated when the link is activated.

HRESULT IAccessibleHyperlink::endIndex (  [out, retval] long *  index  )

Returns the index at which the textual rerpesentation of the hyperlink ends. The returned value is related to the IAccessibleText interface of the object that owns this hyperlink. The character at the index is not part of the hypertext. Parameters: [out]  index

HRESULT IAccessibleHyperlink::startIndex (  [out, retval] long *  index  )

Returns the index at which the textual representation of the hyperlink starts. The returned value is related to the IAccessibleText interface of the object that owns this hyperlink. Parameters: [out]  index

HRESULT IAccessibleHyperlink::valid (  [out, retval] boolean *  valid  )

Returns whether the target object referenced by this link is still valid. This is a volatile state that may change without sending an appropriate event. Returns TRUE if the referenced target is still valid and FALSE otherwise. Parameters: [out]  valid

---

The documentation for this interface was generated from the following file:

• AccessibleHyperlink.idl

---