Class Connector

Represents a objects used to create link between two points, nodes or ports to represent the relationships between them.

Inheritance
System.Object
ConnectorBase
Connector
BpmnFlow
Implements
System.IDisposable
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: Syncfusion.UI.Xaml.Diagram
Assembly: Syncfusion.SfDiagram.WPF.dll
Syntax
public class Connector : ConnectorBase, IConnectorView, IView, ISharedData, IDisposable, IConnector, IConnectorBase, IGroupable, IDiagramElement, IID, INotifyPropertyChanged

Constructors

Connector()

Initializes a new instance of the Connector class.

Declaration
public Connector()

Fields

AnnotationConstraintsProperty

Using a DependencyProperty as the backing store for AnnotationConstraints. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty AnnotationConstraintsProperty
Field Value
Type
System.Windows.DependencyProperty

AnnotationsProperty

Using a DependencyProperty as the backing store for Annotations. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty AnnotationsProperty
Field Value
Type
System.Windows.DependencyProperty

BezierSmoothnessProperty

Using a DependencyProperty as the backing store for BezierSmoothness. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty BezierSmoothnessProperty
Field Value
Type
System.Windows.DependencyProperty

BridgeSpaceProperty

Using a DependencyProperty as the backing store for BridgeSpace. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty BridgeSpaceProperty
Field Value
Type
System.Windows.DependencyProperty

ConstraintsProperty

Using a DependencyProperty as the backing store for Constraints. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty ConstraintsProperty
Field Value
Type
System.Windows.DependencyProperty

CornerRadiusProperty

Using a DependencyProperty as the backing store for CornerRadius. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty CornerRadiusProperty
Field Value
Type
System.Windows.DependencyProperty

IDProperty

Using a DependencyProperty as the backing store for ID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty IDProperty
Field Value
Type
System.Windows.DependencyProperty

IsSelectedProperty

Using a DependencyProperty as the backing store for IsSelected. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty IsSelectedProperty
Field Value
Type
System.Windows.DependencyProperty

MenuProperty

Using a DependencyProperty as the backing store for Menu. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty MenuProperty
Field Value
Type
System.Windows.DependencyProperty

ParentGroupProperty

Using a DependencyProperty as the backing store for ParentGroup. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty ParentGroupProperty
Field Value
Type
System.Windows.DependencyProperty

PortVisibilityProperty

Using a DependencyProperty as the backing store for PortVisibility. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty PortVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

SearchTagsProperty

Identifies the SearchTags dependency property.

Declaration
public static DependencyProperty SearchTagsProperty
Field Value
Type
System.Windows.DependencyProperty

SegmentDecoratorsProperty

Using a DependencyProperty as the backing store for SegmentDecorators. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SegmentDecoratorsProperty
Field Value
Type
System.Windows.DependencyProperty

SegmentDecoratorStyleProperty

Using a DependencyProperty as the backing store for SegmentDecoratorStyle. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SegmentDecoratorStyleProperty
Field Value
Type
System.Windows.DependencyProperty

SourceConnectorIDProperty

Using a DependencyProperty as the backing store for SourceConnectorID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceConnectorIDProperty
Field Value
Type
System.Windows.DependencyProperty

SourceConnectorProperty

Using a DependencyProperty as the backing store for SourceConnector. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceConnectorProperty
Field Value
Type
System.Windows.DependencyProperty

SourceDecoratorPivotProperty

Using a DependencyProperty as the backing store for SourceDecoratorPivot. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceDecoratorPivotProperty
Field Value
Type
System.Windows.DependencyProperty

SourceDecoratorProperty

Using a DependencyProperty as the backing store for SourceDecorator. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceDecoratorProperty
Field Value
Type
System.Windows.DependencyProperty

SourceDecoratorStyleProperty

Using a DependencyProperty as the backing store for SourceDecoratorStyle. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceDecoratorStyleProperty
Field Value
Type
System.Windows.DependencyProperty

SourceNodeIDProperty

Using a DependencyProperty as the backing store for SourceNodeID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceNodeIDProperty
Field Value
Type
System.Windows.DependencyProperty

SourceNodeProperty

Using a DependencyProperty as the backing store for SourceNode. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourceNodeProperty
Field Value
Type
System.Windows.DependencyProperty

SourcePaddingProperty

Using a DependencyProperty as the backing store for SourcePadding. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourcePaddingProperty
Field Value
Type
System.Windows.DependencyProperty

SourcePortIDProperty

Using a DependencyProperty as the backing store for SourcePortID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourcePortIDProperty
Field Value
Type
System.Windows.DependencyProperty

SourcePortProperty

Using a DependencyProperty as the backing store for SourcePort. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty SourcePortProperty
Field Value
Type
System.Windows.DependencyProperty

TargetConnectorIDProperty

Using a DependencyProperty as the backing store for TargetConnectorID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetConnectorIDProperty
Field Value
Type
System.Windows.DependencyProperty

TargetConnectorProperty

Using a DependencyProperty as the backing store for TargetConnector. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetConnectorProperty
Field Value
Type
System.Windows.DependencyProperty

TargetDecoratorPivotProperty

Using a DependencyProperty as the backing store for TargetDecoratorPivot. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetDecoratorPivotProperty
Field Value
Type
System.Windows.DependencyProperty

TargetDecoratorProperty

Using a DependencyProperty as the backing store for TargetDecorator. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetDecoratorProperty
Field Value
Type
System.Windows.DependencyProperty

TargetDecoratorStyleProperty

Using a DependencyProperty as the backing store for TargetDecoratorStyle. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetDecoratorStyleProperty
Field Value
Type
System.Windows.DependencyProperty

TargetNodeIDProperty

Using a DependencyProperty as the backing store for TargetNodeID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetNodeIDProperty
Field Value
Type
System.Windows.DependencyProperty

TargetNodeProperty

Using a DependencyProperty as the backing store for TargetNode. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetNodeProperty
Field Value
Type
System.Windows.DependencyProperty

TargetPaddingProperty

Using a DependencyProperty as the backing store for TargetPadding. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetPaddingProperty
Field Value
Type
System.Windows.DependencyProperty

TargetPortIDProperty

Using a DependencyProperty as the backing store for TargetPortID. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetPortIDProperty
Field Value
Type
System.Windows.DependencyProperty

TargetPortProperty

Using a DependencyProperty as the backing store for TargetPort. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty TargetPortProperty
Field Value
Type
System.Windows.DependencyProperty

ThemeStyleIdProperty

Using a DependencyProperty as the backing store for ThemeStyleId. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty ThemeStyleIdProperty
Field Value
Type
System.Windows.DependencyProperty

ZIndexProperty

Using a DependencyProperty as the backing store for ZIndex. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty ZIndexProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

AnnotationConstraints

Gets or sets the default behaviors of the annotation.

Declaration
public AnnotationConstraints AnnotationConstraints { get; set; }
Property Value
Type
AnnotationConstraints

Annotations

Gets or sets a collection of objects where each object represent a IAnnotation.

Declaration
public object Annotations { get; set; }
Property Value
Type
System.Object

BezierSmoothness

Gets or sets the beziersmoothness of the connector.

Declaration
public BezierSmoothness BezierSmoothness { get; set; }
Property Value
Type
BezierSmoothness

BoundingRectangle

Gets or sets the bounding rectangle of the Connector.

Declaration
public Rect BoundingRectangle { get; }
Property Value
Type
System.Windows.Rect

BridgeSpace

Gets or sets the width of the line bridges.

Declaration
public double BridgeSpace { get; set; }
Property Value
Type
System.Double

Constraints

Gets or sets the default behaviors of the connector.

Declaration
public ConnectorConstraints Constraints { get; set; }
Property Value
Type
ConnectorConstraints

CornerRadius

Gets or sets the radius of the rounded corner.

Declaration
public double CornerRadius { get; set; }
Property Value
Type
System.Double

ID

Gets or sets the id of the connector

Declaration
public object ID { get; set; }
Property Value
Type
System.Object

Info

Gets or sets the info of the Connector.

Declaration
public object Info { get; set; }
Property Value
Type
System.Object

IsConnecting

Gets a value that determines whether the connector has connecting.

Declaration
public bool IsConnecting { get; }
Property Value
Type
System.Boolean

IsSelected

Gets or sets a value indicates whether the Connector is selected. The default value is set to false.

Declaration
public bool IsSelected { get; set; }
Property Value
Type
System.Boolean

Menu

Gets or sets some additional menu items.

Declaration
public DiagramMenu Menu { get; set; }
Property Value
Type
DiagramMenu

ParentGroup

Gets or sets the name of the parent group.

Declaration
public object ParentGroup { get; set; }
Property Value
Type
System.Object

PortVisibility

Gets or sets when the Port should be visible.

Declaration
public PortVisibility PortVisibility { get; set; }
Property Value
Type
PortVisibility

SearchTags

Gets or sets the search tags of the Connector in the Syncfusion.UI.Xaml.Diagram.Stencil.

Declaration
public IEnumerable<string> SearchTags { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

The list of search tags that are used when you search for the symbol in the Syncfusion.UI.Xaml.Diagram.Stencil. The default is null.

SegmentDecorators

Gets or sets a collection of Segment decorators where each object represent a ISegmentDecorator.

Declaration
public object SegmentDecorators { get; set; }
Property Value
Type
System.Object

SegmentDecoratorStyle

Gets or sets the style of the Segment decorator.

Declaration
public Style SegmentDecoratorStyle { get; set; }
Property Value
Type
System.Windows.Style

SourceConnector

Gets or sets the source connector of the connector.

Declaration
public object SourceConnector { get; set; }
Property Value
Type
System.Object

SourceConnectorID

Gets or sets the id for source connector of the connector.

Declaration
public object SourceConnectorID { get; set; }
Property Value
Type
System.Object

SourceDecorator

Gets or sets the source decorator value to decorate some customizable shapes like arrows, circles, diamond or path of the connector.

Declaration
public object SourceDecorator { get; set; }
Property Value
Type
System.Object

SourceDecoratorPivot

Gets or sets the ratio/fractional value relative to SourcePoint, based on which the Decorator will be transformed.

Declaration
public Point SourceDecoratorPivot { get; set; }
Property Value
Type
System.Windows.Point

SourceDecoratorStyle

Gets or sets the style of the source decorator.

Declaration
public Style SourceDecoratorStyle { get; set; }
Property Value
Type
System.Windows.Style

SourceNode

Gets or sets the source node of the connector.

Declaration
public object SourceNode { get; set; }
Property Value
Type
System.Object

SourceNodeID

Gets or sets the id for source node of the connector.

Declaration
public object SourceNodeID { get; set; }
Property Value
Type
System.Object

SourcePadding

Gets or sets the space to be left between the source node and the source point of a connector.

Declaration
public double SourcePadding { get; set; }
Property Value
Type
System.Double

SourcePort

Gets or sets the source port of the connector.

Declaration
public IPort SourcePort { get; set; }
Property Value
Type
IPort

SourcePortID

Gets or sets the id for source port of the connector.

Declaration
public object SourcePortID { get; set; }
Property Value
Type
System.Object

TargetConnector

Gets or sets the target connector of the connector.

Declaration
public object TargetConnector { get; set; }
Property Value
Type
System.Object

TargetConnectorID

Gets or sets the id for target connector of the connector.

Declaration
public object TargetConnectorID { get; set; }
Property Value
Type
System.Object

TargetDecorator

Gets or sets the taregt decorator value to decorate some customizable shapes like arrows, circles, diamond or path of the connector.

Declaration
public object TargetDecorator { get; set; }
Property Value
Type
System.Object

TargetDecoratorPivot

Gets or sets the ratio/fractional value relative to TargetPoint, based on which the Decorator will be transformed.

Declaration
public Point TargetDecoratorPivot { get; set; }
Property Value
Type
System.Windows.Point

TargetDecoratorStyle

Gets or sets the style of the target decorator.

Declaration
public Style TargetDecoratorStyle { get; set; }
Property Value
Type
System.Windows.Style

TargetNode

Gets or sets the target node of the Connector.

Declaration
public object TargetNode { get; set; }
Property Value
Type
System.Object

TargetNodeID

Gets or sets the id for target node of the connector.

Declaration
public object TargetNodeID { get; set; }
Property Value
Type
System.Object

TargetPadding

Gets or sets the space to be left between the target node and the target point of the connector.

Declaration
public double TargetPadding { get; set; }
Property Value
Type
System.Double

TargetPort

Gets or sets the target port of the connector.

Declaration
public IPort TargetPort { get; set; }
Property Value
Type
IPort

TargetPortID

Gets or sets the id for target port of the connector.

Declaration
public object TargetPortID { get; set; }
Property Value
Type
System.Object

ThemeStyleId

Gets or sets the themestyleid of the Connector

Declaration
public StyleId ThemeStyleId { get; set; }
Property Value
Type
StyleId

ZIndex

Gets or sets the z-index of the connector.

Declaration
public int ZIndex { get; set; }
Property Value
Type
System.Int32

Methods

ArrangeOverride(Size)

Method to arrange Connector class elements to given size.

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type Name Description
System.Windows.Size finalSize

Size to arrange elements.
Returns
Type Description
System.Windows.Size

Return size.
Overrides

CanDisconnectOnDrag()

Connect or Disconnect end thumbs of the connector while dragging the connector, if the connector connects with Node or Port. By default, its return true. So, the end thumbs are disconnected while dragging the connected connector.

Declaration
protected virtual bool CanDisconnectOnDrag()
Returns
Type
System.Boolean

CreateSegments(Point, Point, BridgeDirection)

Creates a bridge segment of the connector for the given start, end and direction value .

Declaration
protected virtual IEnumerable<PathSegment> CreateSegments(Point start, Point end, BridgeDirection direction)
Parameters
Type Name Description
System.Windows.Point start
System.Windows.Point end
BridgeDirection direction
Returns
Type
System.Collections.Generic.IEnumerable<System.Windows.Media.PathSegment>

MeasureOverride(Size)

Method to arrange Connector class elements to given size.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
Type Name Description
System.Windows.Size availableSize

Size to arrange elements.
Returns
Type Description
System.Windows.Size

Return size.
Overrides

OnApplyTemplate()

Method to apply template values to BpmnGroup class.

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type
System.Windows.Automation.Peers.AutomationPeer

ShowBothContextMenu(Connector, MouseButtonEventArgs)

To show the Connector Context Menu and Diagram Context Menu.

Declaration
public void ShowBothContextMenu(Connector connector, MouseButtonEventArgs e)
Parameters
Type Name Description
Connector connector
System.Windows.Input.MouseButtonEventArgs e

ShowContextMenu(FrameworkElement, MouseButtonEventArgs)

To show the Connector Context Menu.

Declaration
public void ShowContextMenu(FrameworkElement sfDiagram, MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.FrameworkElement sfDiagram

element
System.Windows.Input.MouseButtonEventArgs e

Event args

UpdateCornerRadius()

UpdateCornerRadius should convert a normal connector with specified corner radius.

Declaration
protected virtual void UpdateCornerRadius()

UpdateGeometry()

UpdateGeometry is used to find route and update connector's geometry visually.

Declaration
protected virtual void UpdateGeometry()

Implements

System.IDisposable
IID
System.ComponentModel.INotifyPropertyChanged