Modal Property (GoToolPanning)

Gets or sets whether this tool is used in a modal fashion when AutoPan is false.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Property Modal As Boolean

public virtual bool Modal {get; set;}

Property Value

the initial value is false

Remarks

This property is ignored when AutoPan is true.

When you add an instance of this non-autopanning tool to the MouseDownTools, you are using it in a non-Modal fashion.

            GoToolPanning panningtool = new GoToolPanning(myView);
            panningtool.AutoPan = false;
            myView.MouseDownTools.Add(panningtool);

This allows the user to use the other mode-less mouse tools, such as selecting, dragging, resizing, and linking as well as this manual panning tool when the user does a mouse down in the background.

If you use this manual panning tool in a modal fashion, the user will remain in this tool, able to pan the view whenever the user drags the mouse anywhere in the view.

            GoToolPanning panningtool = new GoToolPanning(myView);
            panningtool.AutoPan = false;
            panningtool.Modal = true;
            myView.Tool = panningtool;

The user can leave this mode by pressing the Cancel key or any other key.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

GoToolPanning Class
GoToolPanning Members