LibreOffice Module winaccessibility (master) 1
Properties | List of all members
IAccessibleHypertext2 Interface Reference

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

import"ia2_api_all.idl";

Inheritance diagram for IAccessibleHypertext2:
[legend]
Collaboration diagram for IAccessibleHypertext2:
[legend]

Properties

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

Additional Inherited Members

- Public Member Functions inherited from IAccessibleText
HRESULT addSelection ([in] long startOffset, [in] long endOffset)
 Adds a text selection. More...
 
HRESULT removeSelection ([in] long selectionIndex)
 Unselects a range of text. More...
 
HRESULT setCaretOffset ([in] long offset)
 Sets the position of the caret. More...
 
HRESULT setSelection ([in] long selectionIndex, [in] long startOffset, [in] long endOffset)
 Changes the bounds of an existing selection. More...
 
HRESULT scrollSubstringTo ([in] long startIndex, [in] long endIndex, [in] enum IA2ScrollType scrollType)
 Makes a specific part of string visible on screen. More...
 
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. More...
 

Detailed Description

This interface exposes information about hypertext in a document.

The IAccessibleHypertext2 interface extends the functionality of the IAccessibleHypertext interface.

Definition at line 3693 of file ia2_api_all.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]hyperlinksThis array is allocated by the server. The client must free it with CoTaskMemFree.
[out]nHyperlinksThe number of links returned; the size of the returned array.
Return values
S_OK
S_FALSEif there are no links, [out] values are NULL and 0 respectively

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