Hide Table of Contents
GetMouseDragMode Method (ISldWorks)

Gets whether the specified command-mouse mode is in effect.

.NET Syntax

Visual Basic (Declaration) 
Function GetMouseDragMode( _
   ByVal Command As Integer _
) As Boolean
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim Command As Integer
Dim value As Boolean
value = instance.GetMouseDragMode(Command)
bool GetMouseDragMode( 
   int Command
bool GetMouseDragMode( 
&   int Command


Command mode you wish to check as defined in swMouseDragMode_e

Return Value

True if the specified command is the currently running command, false if not


This method determines if a special mouse mode is in use. Generally, these mouse modes are indicated visually with a different cursor and different mouse input interpretation. For example, one such mode is View Rotate mode. This is indicated visually to the user with a different cursor. When in this mode, the mouse input manipulates interactive view rotation, and the View Rotate toolbar button is pressed.

A complete list of valid mouse modes can be found in the swMouseDragMode_e enumeration.

The mouse mode applies to your whole SolidWorks session, not a specific document. Therefore, if the user is currently working in an assembly document and is in Translate Assembly Component mode, then switching to a part or drawing document does not exit the mouse mode. If you call this method at this time to check for swTranslateAssemblyComponent, it returns True.

That mode is retained until a new command is entered, regardless if that this mode is not appropriate for a part or drawing document. When a new interactive command or API command runs, it terminates the Translate Assembly Component mode.

There is currently no general method to enable these mouse modes. However, several specific functions exist that enable or toggle certain modes. For example, IAssemblyDoc::TranslateComponent and IAssemblyDoc::RotateComponent. To disable any of these modes, use IModelDoc2::SetPickMode.


See Also


SolidWorks 99, datecode 1999207

Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   GetMouseDragMode Method (ISldWorks)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2012 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.