Class ClickSelectingTool

Namespace

Northwoods.Go.Tools

Assembly

Northwoods.GoDiagram.WinForms.dll

The ClickSelectingTool selects and deselects Parts when there is a click. It does this by calling StandardMouseSelect(). It is also responsible for handling and dispatching click events on GraphObjects by calling StandardMouseClick(Func<GraphObject, GraphObject>).

public class ClickSelectingTool : Tool

Inheritance

object

Tool

ClickSelectingTool

Inherited Members

Tool.Diagram

Tool.UpdateAdornments(Part)

Tool.DoStart()

Tool.DoActivate()

Tool.DoDeactivate()

Tool.DoStop()

Tool.DoCancel()

Tool.StopTool()

Tool.DoMouseDown()

Tool.DoMouseMove()

Tool.DoMouseWheel()

Tool.CanStartMultiTouch()

Tool.StandardPinchZoomStart()

Tool.StandardPinchZoomMove()

Tool.DoKeyDown()

Tool.DoKeyUp()

Tool.StartTransaction(string)

Tool.StopTransaction()

Tool.StandardMouseSelect()

Tool.StandardMouseClick(Func<GraphObject, GraphObject>, Predicate<GraphObject>)

Tool.StandardMouseClick(Func<GraphObject, GraphObject>)

Tool.StandardMouseOver()

Tool.StandardMouseWheel()

Tool.StandardWaitAfter(double, InputEvent)

Tool.CancelWaitAfter()

Tool.DoWaitAfter(InputEvent)

Tool.FindToolHandleAt(Point, string)

Tool.IsBeyondDragSize(Point?, Point?)

Tool.Name

Tool.IsEnabled

Tool.IsActive

Tool.TransactionResult

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Note that this tool avoids raising click events on objects that are in temporary layers. This is to prevent parts such as selection adornments from interfering with clicking on selected nodes or links. (Adornments are in the "Adornment" Layer, which IsTemporary.) However this means that if you add a Click event handler on a GraphObject in an Adornment, it will not be called. You can get it to be called by setting IsActionable to true on that object in the adornment.

This tool is a standard mouse-up tool, the ClickSelectingTool.

This tool does not utilize any Adornments or tool handles. This tool does not modify the model or conduct any transaction.

An example customization of this tool is shown in the Tree Map sample, where the StandardMouseSelect() method is overridden to permit the user to cycle through the chain of containing groups, changing the selection on each click to the next containing group.

If you want to programmatically select a Part, you can set IsSelected or call Select(Part). If you want to know which Part is at a particular point, you can call FindPartAt(Point, bool).

Constructors

ClickSelectingTool()

You do not normally need to create an instance of this tool because one already exists as the ClickSelectingTool.

The Name of this tool is "ClickSelecting".

public ClickSelectingTool()

Methods

CanStart()

This tool can run whenever a click occurs.

public override bool CanStart()

Returns

bool

Remarks

This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

DoMouseUp()

Upon a click, this calls StandardMouseSelect() to change the Selection collection, then calls StandardMouseClick(Func<GraphObject, GraphObject>) to perform the normal click behaviors, and then stops this tool.

public override void DoMouseUp()