CheckKeyModifier Method

Summary

Determines if the specified key modifier is currently in a pressed state.

Syntax

C++

public static bool CheckKeyModifier( 
   EventArgs e, 
   Keys key 
)

Public Shared Function CheckKeyModifier( 
   ByVal e As System.EventArgs, 
   ByVal key As System.Windows.Forms.Keys 
) As Boolean

public:  
   static bool CheckKeyModifier( 
      System::EventArgs^ e, 
      System::Windows::Forms::Keys^ key 
   )

Parameters

Not used.

key

Key to check.

Return Value

true if the modifier specified by key is currently in a pressed state, otherwise; false.

Remarks

This method is used by the various ImageViewerInteractiveMode instances that support a key modifier. For example, holding down CTRL while dragging the mouse in ImageViewerPanZoomInteractiveMode will perform a zoom operation instead of a pan. The interactive mode will call this method to determine the status of the CTRL modifier.

Requirements

Target Platforms