How do I determine when a new link has been added to or removed from the Diagram in WinForms?
How do I determine when a new link has been added to or removed from the Diagram in WinForms?
The WinForms Diagram.Model.ConnectionsChangeComplete event can be used to determine when a new Link has been added or removed from the diagram.
The event's ConnectionCollectionEventArgs event argument provides information about the nature of the change and the connection(s) that were involved. Examining the Connection object's SourcePort and TargetPort properties for an object of type 'LinkPort' and accessing the LinkPort's Container property will let you get hold of the link that was involved in the connection. Once the link is available, the Link.FromNode and Link.ToNode properties may be used to get hold of the symbols that the link connects.
The following code sample demonstrates how to detect a new link being added to the Diagram. In the snippet we also examine the symbols that the new link connects, and if the symbols are found to be of the same type, remove the link from the diagram.
C#
// Use the Diagram.ConnectionsChangeComplete event to be notified of the creation of a new Link.
// The Link.FromNode and Link.ToNode properties provide access to the symbols that the link connects.
private void diagram1_ConnectionsChangeComplete(object sender, Syncfusion.Windows.Forms.Diagram.ConnectionCollectionEventArgs evtArgs)
{
if ((evtArgs.ChangeType == Syncfusion.Windows.Forms.Diagram.CollectionExChangeType.Insert) && (evtArgs.Connection != null))
{
Connection newconn = evtArgs.Connection;
Link newlink = null;
if (newconn.SourcePort is LinkPort)
newlink = newconn.SourcePort.Container as Link;
else if (newconn.TargetPort is LinkPort)
newlink = newconn.TargetPort.Container as Link;
if ((newlink != null) && (newlink.FromNode != null) && (newlink.ToNode != null))
{
Trace.WriteLine("A new link was added to the Diagram");
Symbol tailsymbol = newlink.FromNode as Symbol;
Symbol headsymbol = newlink.ToNode as Symbol;
if ((tailsymbol.Nodes.Count == headsymbol.Nodes.Count) && (tailsymbol.Nodes[0].Name == headsymbol.Nodes[0].Name))
{
// Comparing the symbol's child nodes count and child node type is a simplistic way
// to determine whether the two symbols are of the same type.
Trace.WriteLine("The two symbols are of the same type.");
// Use the RemoveNodesCmd to delete the new link
RemoveNodesCmd removecmd = new RemoveNodesCmd();
removecmd.Nodes.Add(newlink);
this.diagram1.Controller.ExecuteCommand(removecmd);
}
}
}
}
VB
Private Sub diagram1_ConnectionsChangeComplete(ByVal sender As Object, ByVal evtArgs As Syncfusion.Windows.Forms.Diagram.ConnectionCollectionEventArgs) Handles diagram1.ConnectionsChangeComplete
If evtArgs.ChangeType = Syncfusion.Windows.Forms.Diagram.CollectionExChangeType.Insert AndAlso Not (evtArgs.Connection Is Nothing) Then
Dim newconn As Connection = evtArgs.Connection
Dim newlink As Link = Nothing
If TypeOf newconn.SourcePort Is LinkPort Then
newlink = newconn.SourcePort.Container
End If
If TypeOf newconn.TargetPort Is LinkPort Then
newlink = newconn.TargetPort.Container
End If
If Not (newlink Is Nothing) AndAlso Not (newlink.FromNode Is Nothing) AndAlso Not (newlink.ToNode Is Nothing) Then
Trace.WriteLine("A new link was added to the Diagram")
Dim tailsymbol As Symbol = newlink.FromNode
Dim headsymbol As Symbol = newlink.ToNode
If tailsymbol.Nodes.Count = headsymbol.Nodes.Count AndAlso tailsymbol.Nodes(0).Name = headsymbol.Nodes(0).Name Then
' Comparing the symbol's child nodes count and child node type is a simplistic way
' to determine whether the two symbols are of the same type.
Trace.WriteLine("The two symbols are of the same type.")
' Use the RemoveNodesCmd to delete the new link
Dim removecmd As New RemoveNodesCmd
removecmd.Nodes.Add(newlink)
Me.diagram1.Controller.ExecuteCommand(removecmd)
End If
End If
End If
End Sub
Conclusion
I hope you enjoyed learning about how to determine when a new link has been added to or removed from the Diagram in WinForms.
You can refer to our WinForms Diagram feature tour page to learn about its other groundbreaking feature representations. You can also explore our documentation to understand how to create and manipulate data.
For current customers, you can check out our components from the License and Downloads page. If you are new to Syncfusion®, you can try our 30-day free trial to check out our other controls.
If you have any queries or require clarifications, please let us know in the comments section below. You can also contact us through our support forums, Direct-Trac, or feedback portal. We are always happy to assist you!
