Stop Method

Summary

Stops the mode.

Syntax

C++

public virtual void Stop( 
   ImageViewer imageViewer 
)

Public Overridable Sub [Stop]( 
   ByVal imageViewer As ImageViewer 
)

public:  
   virtual void Stop( 
      ImageViewer^ imageViewer 
   )

Parameters

imageViewer

The image viewer to associate with this mode.

Remarks

This method must be overridden in your derived class when implementing your own interactive modes. For an example, refer to ImageViewerInteractiveMode.

The ImageViewer will call Stop when the user removes this mode from the viewer or disables it. Typically, the mode should unsubscribe to the required events in InteractiveService previously used in Start.

Example

For an example, refer to ImageViewerInteractiveMode.

Requirements

Target Platforms