IVsWindowPane.TranslateAccelerator(MSG[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Handles the translation of special navigation keys.

public:
 int TranslateAccelerator(cli::array <Microsoft::VisualStudio::OLE::Interop::MSG> ^ lpmsg);

int TranslateAccelerator(std::Array <Microsoft::VisualStudio::OLE::Interop::MSG> const & lpmsg);

public int TranslateAccelerator (Microsoft.VisualStudio.OLE.Interop.MSG[] lpmsg);

abstract member TranslateAccelerator : Microsoft.VisualStudio.OLE.Interop.MSG[] -> int

Public Function TranslateAccelerator (lpmsg As MSG()) As Integer

Parameters

lpmsg: MSG[]

[in] Keyboard character or character combination to be handled.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsWindowPane::TranslateAccelerator(  
   LPMSG lpmsg  
);

This method is identical to the TranslateAccelerator. This provides you the opportunity to handle keyboard messages before they are dispatched to the window that has focus. For example, your window might have controls where the TAB key navigates from one to the next. To handle the TAB key properly, you need to intercept it before it is dispatched to the window. Often, there is no requirement to implement this method.

Applies to