IAccessible::accDoDefaultAction

The IAccessible::accDoDefaultAction method performs the specified object's default action. Not all objects have a default action.

HRESULT accDoDefaultAction(
VARIANTvarID);

Parameters

• varID
  [in] Specifies whether the default action is that of the object or of one of the object's child elements. For more information about initializing the VARIANT structure, see How Child IDs Are Used in Parameters.

Return Values

If successful, returns S_OK.

If not successful, returns one of the following values or another standard COM error code.

Remarks

Clients retrieve a string that describes the object's default action by calling IAccessible::get_accDefaultAction.

Note to client developers  When used on a menu item in a standard system menu, accDoDefaultAction returns S_OK but fails to perform the action if the character used in the access key (the underlined character in the text of a menu item name, also called a mnemonic) is ?, !, @, or any other character that requires the SHIFT key or another modifier key. This also happens on international keyboards with an access key character that requires the ALT GR key to be pressed. This is not an issue for menus in other applications, such as Microsoft Office or Internet Explorer. For more information about access keys, see IAccessible::get_accKeyboardShortcut.

Also, while accDoDefaultAction is supposed to return immediately, some implementations block the return. For example, if clicking a link displays a dialog, some implementations will block the return until the dialog is dismissed. Such delays can prevent client applications from processing a dialog box. Servers should avoid implementations that block returns.

Server Example

The following example shows a possible implementation for a custom list control whose default action is a double-click on a child item. To prevent blocking, the method posts a custom message that, when received by the control window, triggers an action, such as displaying item properties.

// Assume a previous definition such as this:
// #define CUSTOMLB_DEFERDOUBLECLICK   (WM_USER + 1)

HRESULT STDMETHODCALLTYPE AccServer::accDoDefaultAction( 
    VARIANT varChild) 
{
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal != CHILDID_SELF)
    {
        // It is assumed that the control does its own checking to see which
        // item has the focus when it receives this message.
        PostMessage(m_hwnd, CUSTOMLB_DEFERDOUBLECLICK, 0, 0);
    }
    return S_OK;
};

Client Example

The following example function performs the default action on a control.

HRESULT DoAction(IAccessible* pAcc)
{
	VARIANT varId;
	varId.vt = VT_I4;
	varId.lVal = CHILDID_SELF;
	return pAcc->accDoDefaultAction(varId);
}

Requirements

**  Windows NT/2000/XP/Server 2003:** Included in Windows 2000 and later.
**  Windows 95/98/Me:** Included in Windows 98 and later.
**  Redistributable:** Requires Active Accessibility 1.3 RDK on Windows NT 4.0 SP6 and Windows 95.
**  Header:** Declared in Oleacc.h.
**  Library:** Use Oleacc.lib.

See Also

IAccessible::get_accDefaultAction, IAccessible::get_accKeyboardShortcut, VARIANT Structure, Appendix A: Supported User Interface Elements Reference, DefaultAction Property