Share via

TranslateAccelerator method

  • Article

Called by MSHTML to translate a key combination entered by a user into an appropriate command.

Syntax

HRESULT retVal = object.TranslateAccelerator(inEvtDispId, pIEventObj);

Parameters

  • inEvtDispId [in]
    Type: DISPID

    A DISPID that specifies the event.

  • pIEventObj [in]
    Type: IHTMLEventObj

    A pointer to an IHTMLEventObj interface that specifies the event.

Remarks

MSHTML calls this method to translate a user's keyboard input in the editor's environment. In a custom editor implementation, this method enables you to customize the behavior of keyboard shortcuts that are used with the editor.

The DISPID parameter provides the most efficient way for an IHTMLEditDesigner method to determine what type of event triggered the method call. The DISPID_HTMLELEMENTEVENTS2 identifiers are defined in Mshtmdid.h.

Note  IME events do not have DISPIDs, so the DISPID parameter is zero for any IME event. If a designer handles IME events and the DISPID is zero, the designer can determine the event type from the IHTMLEventObj::srcElement property.