This interface exposes the primary set of information about an IAccessible2 enabled accessible object. More...

import"ia2_api_all.idl";

Inheritance diagram for IAccessible2_2:

Collaboration diagram for IAccessible2_2:

Properties
VARIANT	attribute ([in] BSTR name) `[get]`
	Returns the attribute value of a specified attribute specific to this object. More...

long	accessibleWithCaret ([out] IUnknown accessible) `[get]`
	Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it. More...

long	relationTargetsOfType ([in] BSTR type,[in] long maxTargets,[out, size_is(, *nTargets)] IUnknown targets) `[get]`
	Returns relation targets for a specified target type. More...

Properties inherited from IAccessible2
long	nRelations `[get]`
	Returns the number of accessible relations for this object. More...

IAccessibleRelation	relation ([in] long relationIndex) `[get]`
	Returns one accessible relation for this object. More...

long	relations ([in] long maxRelations,[out, size_is(maxRelations), length_is(*nRelations)] IAccessibleRelation relations) `[get]`
	Returns multiple accessible relations for this object. More...

long	groupPosition ([out] long groupLevel,[out] long similarItemsInGroup) `[get]`
	Returns grouping information. More...

AccessibleStates	states `[get]`
	Returns the bit strip containing any IAccessible2 states. More...

BSTR	extendedRole `[get]`
	Returns the extended role. More...

BSTR	localizedExtendedRole `[get]`
	Returns the localized extended role. More...

long	nExtendedStates `[get]`
	Returns the number of extended states. More...

long	extendedStates ([in] long maxExtendedStates,[out, size_is(, maxExtendedStates), length_is(, *nExtendedStates)] BSTR extendedStates) `[get]`
	Returns the extended states (array of strings). More...

long	localizedExtendedStates ([in] long maxLocalizedExtendedStates,[out, size_is(, maxLocalizedExtendedStates), length_is(, *nLocalizedExtendedStates)] BSTR localizedExtendedStates) `[get]`
	Returns the localized extended states (array of strings). More...

long	uniqueID `[get]`
	Returns the unique ID. More...

HWND	windowHandle `[get]`
	Returns the window handle for the parent window which contains this object. More...

long	indexInParent `[get]`
	Returns the index of this object in its parent object. More...

IA2Locale	locale `[get]`
	Returns the IA2Locale of the accessible object. More...

BSTR	attributes `[get]`
	Returns the attributes specific to this object, such as a cell's formula. More...

Additional Inherited Members
Public Member Functions inherited from IAccessible2
HRESULT	role ([out, retval] long *role)
	Returns the role of an IAccessible2 object. More...

HRESULT	scrollTo ([in] enum IA2ScrollType scrollType)
	Makes an object visible on the screen. More...

HRESULT	scrollToPoint ([in] enum IA2CoordinateType coordinateType, [in] long x, [in] long y)
	Moves the top left of an object to a specified location. More...

Detailed Description

This interface exposes the primary set of information about an IAccessible2 enabled accessible object.

This interface must always be provided for objects that support some portion of the collection of the IAccessible2 interfaces.

Please refer to Changing between Accessible Interfaces for special considerations related to use of the MSAA IAccessible interface and the set of IAccessible2 interfaces.

Definition at line 1960 of file ia2_api_all.idl.

Property Documentation

◆ accessibleWithCaret

long IAccessible2_2::accessibleWithCaret([out] IUnknown accessible)

get

Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it.

Parameters

[out]	accessible
[out]	caretOffset

Return values

S_OK
S_FALSE	returned if there is no caret in any of the objects in the subtree, [out] accessible is NULL and [out] caretOffset is -1.

◆ attribute

VARIANT IAccessible2_2::attribute([in] BSTR name)

get

Returns the attribute value of a specified attribute specific to this object.

Parameters

[in]	name
[out]	attribute

Return values

S_OK
S_FALSE	returned if there is nothing to return, [out] value is NULL.
E_INVALIDARG	if bad [in] passed.

Note: The output value is a VARIANT. Typically it will be a VT_BSTR, but there are some cases where it will be a VT_I4 or VT_BOOL. Refer to the Object Attributes specification for more information.

◆ relationTargetsOfType

long IAccessible2_2::relationTargetsOfType([in] BSTR type, [in] long maxTargets, [out, size_is(,*nTargets)] IUnknown targets)

get

Returns relation targets for a specified target type.

Parameters

[in]	type	The requested relation type.
[in]	maxTargets	The number of targets requested. 0 indicates that all targets should be returned.
[out]	targets	This array is allocated by the server. The client must free it with CoTaskMemFree.
[out]	nTargets	The number of targets returned; the size of the returned array.

Return values

S_OK
S_FALSE	if there are no targets, [out] values are NULL and 0 respectively.
E_INVALIDARG	if bad [in] passed.

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

ia2_api_all.idl

Properties

Additional Inherited Members

Detailed Description

Property Documentation

◆ accessibleWithCaret

◆ attribute

◆ relationTargetsOfType