ArcObjects Library Reference  (SystemUI)    

ITool.Deactivate Method

Causes the tool to no longer be the active tool.

[Visual Basic 6.0]
Function Deactivate As Boolean
[Visual Basic .NET]
Public Function Deactivate ( _
) As Boolean
[C#]
public bool Deactivate (
);
[Java]
public Boolean deactivate (
)
throws
    IOException,
    AutomationException
[C++]
HRESULT Deactivate(
  VARIANT_BOOL* complete
);
[C++]

Parameters

complete [out, retval]

  complete is a parameter of type VARIANT_BOOL

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Remarks

When implementing ITool to create a custom tool, add some logic to the Deactivate method to specify whether this tool can be deactivated. If ITool_Deactivate is set to False, the default, you cannot interact with any other tools because this tool cannot be interrupted by another tool.

[Visual Basic 6.0]
Private Function ITool_Deactivate() As Boolean
  ' Deactivate the tool.     
  ITool_Deactivate = True
End Function 

See Also

ITool Interface

Example

ITool Example

 


Feedback Send feedback on this page