IAccessibleHypertext2 Interface Reference

This interface exposes information about hypertext in a document. More...

Inheritance diagram for IAccessibleHypertext2:

Collaboration diagram for IAccessibleHypertext2:

Properties
long	hyperlinks ([out, size_is(, *nHyperlinks)] IAccessibleHyperlink hyperlinks) [get]
	Returns the links for this object.
Properties inherited from IAccessibleHypertext
long	nHyperlinks [get]
	Returns the number of links and link groups contained within this hypertext paragraph.
IAccessibleHyperlink	hyperlink ([in] long index) [get]
	Returns the specified link.
long	hyperlinkIndex ([in] long charIndex) [get]
	Returns the index of the hyperlink that is associated with this character index.
Properties inherited from IAccessibleText
BSTR	attributes ([in] long offset,[out] long startOffset,[out] long endOffset) [get]
	Returns text attributes.
long	caretOffset [get]
	Returns the position of the caret.
long	characterExtents ([in] long offset,[in] IA2CoordinateType coordType,[out] long x,[out] long y,[out] long width) [get]
	Returns the bounding box of the specified position.
long	nSelections [get]
	Returns the number of active non-contiguous selections.
long	offsetAtPoint ([in] long x,[in] long y,[in] IA2CoordinateType coordType) [get]
	Returns the text position for the specified screen position.
long	selection ([in] long selectionIndex,[out] long startOffset) [get]
	Returns the character offsets of Nth active text selection.
BSTR	text ([in] long startOffset,[in] long endOffset) [get]
	Returns the substring between the two given indices.
BSTR	textBeforeOffset ([in] long offset,[in] IA2TextBoundaryType boundaryType,[out] long startOffset,[out] long endOffset) [get]
	Returns a text portion before the given position.
BSTR	textAfterOffset ([in] long offset,[in] IA2TextBoundaryType boundaryType,[out] long startOffset,[out] long endOffset) [get]
	Returns a text portion after the given position.
BSTR	textAtOffset ([in] long offset,[in] IA2TextBoundaryType boundaryType,[out] long startOffset,[out] long endOffset) [get]
	Returns a text portion that spans the given position.
long	nCharacters [get]
	Returns total number of characters.
IA2TextSegment	newText [get]
	Returns any inserted text.
IA2TextSegment	oldText [get]
	Returns any removed text.

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Member Functions inherited from IAccessibleText
HRESULT	addSelection ([in] long startOffset, [in] long endOffset)
	Adds a text selection.
HRESULT	removeSelection ([in] long selectionIndex)
	Unselects a range of text.
HRESULT	setCaretOffset ([in] long offset)
	Sets the position of the caret.
HRESULT	setSelection ([in] long selectionIndex, [in] long startOffset, [in] long endOffset)
	Changes the bounds of an existing selection.
HRESULT	scrollSubstringTo ([in] long startIndex, [in] long endIndex, [in] enum IA2ScrollType scrollType)
	Makes a specific part of string visible on screen.
HRESULT	scrollSubstringToPoint ([in] long startIndex, [in] long endIndex, [in] enum IA2CoordinateType coordinateType, [in] long x, [in] long y)
	Moves the top left of a substring to a specified location.
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Detailed Description

This interface exposes information about hypertext in a document.

The IAccessibleHypertext2 interface extends the functinality of the IAccessibleHypertext interface.

Definition at line 3696 of file iaccessible2.idl.

Property Documentation

hyperlinks

long IAccessibleHypertext2::hyperlinks([out, size_is(,*nHyperlinks)] IAccessibleHyperlink hyperlinks)

get

Returns the links for this object.

The returned IAccessibleHyperlink objects encapsulate the hyperlink and provides several kinds of information describing it.

Parameters

[out]	hyperlinks	This array is allocated by the server. The client must free it with CoTaskMemFree.
[out]	nHyperlinks	The number of links returned; the size of the returned array.

Return values

S_OK
S_FALSE	if there are no links, [out] values are NULL and 0 respectively

---

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

• sdk/include/wine/iaccessible2.idl