Implement this interface to give read-only access to a text.
Description
Implement this interface to expose the hypertext structure of a document.
The XAccessibleHypertext interface is the main interface
to expose hyperlinks in a document, typically a text document, that are
used to reference other (parts of) documents. For supporting the
getLinkIndex method of this
interface and other character related methods of the
XAccessibleHyperlink interface, it is necessary to also
support the XAccessibleText interface.
The returned XAccessibleHyperlink object
encapsulates the hyperlink and provides several kinds of information
describing it.
Parameter nLinkIndex
This index specifies the hyperlink to return.
Returns
If the given index is valid, i.e. lies in the intervall from 0
to the number of links minus one, a reference to the specified
hyperlink object is returned. If the index is invalid then an
empty reference is returned.
Returns the index of the hyperlink that is associated with this
character index.
In a HTML document this is the case when a <a href> tag
spans (includes) the given character index.
Parameter nCharIndex
Index of the character for which to return the link index. If
the XAccessibleText interface is used to represent
the text containting the link, then the character index is only
valid if it is greater than or equal to zero and lower then the
number of characters in the text. See that interface's
documentation for more details.
Returns
Returns the index of the hyperlink that is associated with this
character index, or throws an exception if there is no hyperlink
associated with this index.
