IsValidForAction(MedicalViewerActionType,MedicalViewerMouseButtons) Method

Summary

Determines whether the specified mouse button can be assigned to the specified action.

Syntax

C++

public virtual bool IsValidForAction( 
   MedicalViewerActionType actionType, 
   MedicalViewerMouseButtons mouseButton 
)

  
Public Overloads Overridable Function IsValidForAction( _ 
   ByVal actionType As MedicalViewerActionType, _ 
   ByVal mouseButton As MedicalViewerMouseButtons _ 
) As Boolean

            public: 
virtual bool IsValidForAction(  
   MedicalViewerActionType actionType, 
   MedicalViewerMouseButtons mouseButton 
)

Parameters

actionType
The type of action being tested.

mouseButton
The mouse button that will be checked.

Return Value

true if the mouse button can be assigned to the action; otherwise, false.

Remarks

To avoid exceptions being thrown, call this method to ensure that the mouse button can be assigned to the specified action before calling the SetAction method. For example, if Leadtools.MedicalViewer.MedicalViewerMouseButtons.Wheel is passed to the mouseButton parameter and MedicalViewerActionType.MagnifyGlass to the actionType parameter, the method will throw an exception. This is because the mouse button is not valid for this action. If the same values are passed as parameters to the IsValidForAction method, the method returns false, indicating that the mouse button cannot be used.

Example

For an example, refer to Leadtools.MedicalViewer.MedicalViewer().

Requirements

Target Platforms