Class DiagramConnectorBuilder

Inheritance

System.Object

Syncfusion.EJ2.ControlBuilder

DiagramConnectorBuilder

Namespace: Syncfusion.EJ2.Diagrams

Assembly: Syncfusion.EJ2.dll

Syntax

public class DiagramConnectorBuilder : ControlBuilder

Constructors

DiagramConnectorBuilder()

Declaration

public DiagramConnectorBuilder()

DiagramConnectorBuilder(List<DiagramConnector>)

Declaration

public DiagramConnectorBuilder(List<DiagramConnector> collection)

Parameters

Type	Name	Description
System.Collections.Generic.List<DiagramConnector>	collection

Methods

Add()

Declaration

public void Add()

AddInfo(Object)

Allows the user to save custom information/data about a node/connector

Declaration

public DiagramConnectorBuilder AddInfo(object addInfo)

Parameters

Type	Name	Description
System.Object	addInfo

Returns

Type
DiagramConnectorBuilder

AllowNodeOverlap(Boolean)

Specifies a value indicating whether to overlap the connector over with the source and target node. If the LineRouting is enabled in the diagram, then allowNodeOverlap property will not work.

Declaration

public DiagramConnectorBuilder AllowNodeOverlap(bool allowNodeOverlap)

Parameters

Type	Name	Description
System.Boolean	allowNodeOverlap

Returns

Type
DiagramConnectorBuilder

Annotations(Action<DiagramConnectorAnnotationBuilder>)

Declaration

public DiagramConnectorBuilder Annotations(Action<DiagramConnectorAnnotationBuilder> annotations)

Parameters

Type	Name	Description
System.Action<DiagramConnectorAnnotationBuilder>	annotations

Returns

Type
DiagramConnectorBuilder

Annotations(List<DiagramConnectorAnnotation>)

Declaration

public DiagramConnectorBuilder Annotations(List<DiagramConnectorAnnotation> annotations)

Parameters

Type	Name	Description
System.Collections.Generic.List<DiagramConnectorAnnotation>	annotations

Returns

Type
DiagramConnectorBuilder

BezierSettings(Object)

Sets the bezier settings of editing the segments.

Declaration

public DiagramConnectorBuilder BezierSettings(object bezierSettings)

Parameters

Type	Name	Description
System.Object	bezierSettings

Returns

Type
DiagramConnectorBuilder

BridgeSpace(Double)

Defines the bridgeSpace of connector

Declaration

public DiagramConnectorBuilder BridgeSpace(double bridgeSpace)

Parameters

Type	Name	Description
System.Double	bridgeSpace

Returns

Type
DiagramConnectorBuilder

ConnectionPadding(Double)

Sets the connector padding value

Declaration

public DiagramConnectorBuilder ConnectionPadding(double connectionPadding)

Parameters

Type	Name	Description
System.Double	connectionPadding

Returns

Type
DiagramConnectorBuilder

ConnectorSpacing(Double)

Sets the distance between source node and connector

Declaration

public DiagramConnectorBuilder ConnectorSpacing(double connectorSpacing)

Parameters

Type	Name	Description
System.Double	connectorSpacing

Returns

Type
DiagramConnectorBuilder

Constraints(ConnectorConstraints)

Defines the constraints of connector None - Interaction of the connectors cannot be done. Select - Selects the connector. Delete - Delete the connector. Drag - Drag the connector. DragSourceEnd - Drag the source end of the connector. DragTargetEnd - Drag the target end of the connector. DragSegmentThump - Drag the segment thumb of the connector. AllowDrop - Allow to drop a node. Bridging - Creates bridge on intersection of two connectors. InheritBridging - Creates bridge on intersection of two connectors. PointerEvents - Sets the pointer events. Tooltip - Displays a tooltip for the connectors. InheritToolTip - Displays a tooltip for the connectors. Interaction - Features of the connector used for interaction. ReadOnly - Enables ReadOnly

Declaration

public DiagramConnectorBuilder Constraints(ConnectorConstraints constraints)

Parameters

Type	Name	Description
ConnectorConstraints	constraints

Returns

Type
DiagramConnectorBuilder

CornerRadius(Double)

Sets the corner radius of the connector

Declaration

public DiagramConnectorBuilder CornerRadius(double cornerRadius)

Parameters

Type	Name	Description
System.Double	cornerRadius

Returns

Type
DiagramConnectorBuilder

DragSize(Object)

Defines the size of a drop symbol

Declaration

public DiagramConnectorBuilder DragSize(object dragSize)

Parameters

Type	Name	Description
System.Object	dragSize

Returns

Type
DiagramConnectorBuilder

ExcludeFromLayout(Boolean)

Defines whether the node should be automatically positioned or not. Applicable, if layout option is enabled.

Declaration

public DiagramConnectorBuilder ExcludeFromLayout(bool excludeFromLayout)

Parameters

Type	Name	Description
System.Boolean	excludeFromLayout

Returns

Type
DiagramConnectorBuilder

FixedUserHandles(Action<DiagramConnectorFixedUserHandleBuilder>)

Declaration

public DiagramConnectorBuilder FixedUserHandles(Action<DiagramConnectorFixedUserHandleBuilder> fixedUserHandles)

Parameters

Type	Name	Description
System.Action<DiagramConnectorFixedUserHandleBuilder>	fixedUserHandles

Returns

Type
DiagramConnectorBuilder

FixedUserHandles(List<DiagramConnectorFixedUserHandle>)

Specifies the collection of the fixed user handle

Declaration

public DiagramConnectorBuilder FixedUserHandles(List<DiagramConnectorFixedUserHandle> fixedUserHandles)

Parameters

Type	Name	Description
System.Collections.Generic.List<DiagramConnectorFixedUserHandle>	fixedUserHandles

Returns

Type
DiagramConnectorBuilder

Flip(FlipDirection)

Flip the element in Horizontal/Vertical directions

Declaration

public DiagramConnectorBuilder Flip(FlipDirection flip)

Parameters

Type	Name	Description
FlipDirection	flip

Returns

Type
DiagramConnectorBuilder

FlipMode(FlipMode)

Allows you to flip only the node or along with port and label.

Declaration

public DiagramConnectorBuilder FlipMode(FlipMode flipMode)

Parameters

Type	Name	Description
FlipMode	flipMode

Returns

Type
DiagramConnectorBuilder

HitPadding(Double)

Sets the connector padding value

Declaration

public DiagramConnectorBuilder HitPadding(double hitPadding)

Parameters

Type	Name	Description
System.Double	hitPadding

Returns

Type
DiagramConnectorBuilder

Id(String)

Represents the unique id of nodes/connectors

Declaration

public DiagramConnectorBuilder Id(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type
DiagramConnectorBuilder

Margin(DiagramMargin)

Defines the space to be left between the node and its immediate parent

Declaration

public DiagramConnectorBuilder Margin(DiagramMargin margin)

Parameters

Type	Name	Description
DiagramMargin	margin

Returns

Type
DiagramConnectorBuilder

Margin(Action<DiagramMarginBuilder>)

Declaration

public DiagramConnectorBuilder Margin(Action<DiagramMarginBuilder> margin)

Parameters

Type	Name	Description
System.Action<DiagramMarginBuilder>	margin

Returns

Type
DiagramConnectorBuilder

MaxSegmentThumb(Double)

Sets the maximum segment thumb for the connector

Declaration

public DiagramConnectorBuilder MaxSegmentThumb(double maxSegmentThumb)

Parameters

Type	Name	Description
System.Double	maxSegmentThumb

Returns

Type
DiagramConnectorBuilder

Ports(Object)

Defines the behavior of connection ports

Declaration

public DiagramConnectorBuilder Ports(object ports)

Parameters

Type	Name	Description
System.Object	ports

Returns

Type
DiagramConnectorBuilder

PreviewSize(Object)

Defines the size of the symbol preview

Declaration

public DiagramConnectorBuilder PreviewSize(object previewSize)

Parameters

Type	Name	Description
System.Object	previewSize

Returns

Type
DiagramConnectorBuilder

Segments(Object)

Defines the segments

Declaration

public DiagramConnectorBuilder Segments(object segments)

Parameters

Type	Name	Description
System.Object	segments

Returns

Type
DiagramConnectorBuilder

SegmentThumbShape(SegmentThumbShapes)

Defines the shape for the connector segmentThumb Rhombus - Sets the segmentThumb shape as Rhombus Square - Sets the segmentThumb shape as Square Rectangle - Sets the segmentThumb shape as Rectangle Ellipse - Sets the segmentThumb shape as Ellipse Arrow - Sets the segmentThumb shape as Arrow Diamond - Sets the segmentThumb shape as Diamond OpenArrow - Sets the segmentThumb shape as OpenArrow Circle - Sets the segmentThumb shape as Circle Fletch - Sets the segmentThumb shape as Fletch OpenFetch - Sets the segmentThumb shape as OpenFetch IndentedArrow - Sets the segmentThumb shape as Indented Arrow OutdentedArrow - Sets the segmentThumb shape as Outdented Arrow DoubleArrow - Sets the segmentThumb shape as DoubleArrow

Declaration

public DiagramConnectorBuilder SegmentThumbShape(SegmentThumbShapes segmentThumbShape)

Parameters

Type	Name	Description
SegmentThumbShapes	segmentThumbShape

Returns

Type
DiagramConnectorBuilder

SegmentThumbSize(Double)

Specifies the size of the segment thumb for individual connector. When not set, it defaults to matching the underlying path data

Declaration

public DiagramConnectorBuilder SegmentThumbSize(double segmentThumbSize)

Parameters

Type	Name	Description
System.Double	segmentThumbSize

Returns

Type
DiagramConnectorBuilder

Shape(Object)

Defines the shape of the connector

Declaration

public DiagramConnectorBuilder Shape(object shape)

Parameters

Type	Name	Description
System.Object	shape

Returns

Type
DiagramConnectorBuilder

SourceDecorator(DiagramDecorator)

Defines the source decorator of the connector

Declaration

public DiagramConnectorBuilder SourceDecorator(DiagramDecorator sourceDecorator)

Parameters

Type	Name	Description
DiagramDecorator	sourceDecorator

Returns

Type
DiagramConnectorBuilder

SourceDecorator(Action<DiagramDecoratorBuilder>)

Declaration

public DiagramConnectorBuilder SourceDecorator(Action<DiagramDecoratorBuilder> sourceDecorator)

Parameters

Type	Name	Description
System.Action<DiagramDecoratorBuilder>	sourceDecorator

Returns

Type
DiagramConnectorBuilder

SourceID(String)

Sets the source node/connector object of the connector

Declaration

public DiagramConnectorBuilder SourceID(string sourceID)

Parameters

Type	Name	Description
System.String	sourceID

Returns

Type
DiagramConnectorBuilder

SourcePadding(Double)

Sets the source padding of the connector

Declaration

public DiagramConnectorBuilder SourcePadding(double sourcePadding)

Parameters

Type	Name	Description
System.Double	sourcePadding

Returns

Type
DiagramConnectorBuilder

SourcePoint(DiagramPoint)

Sets the beginning point of the connector

Declaration

public DiagramConnectorBuilder SourcePoint(DiagramPoint sourcePoint)

Parameters

Type	Name	Description
DiagramPoint	sourcePoint

Returns

Type
DiagramConnectorBuilder

SourcePoint(Action<DiagramPointBuilder>)

Declaration

public DiagramConnectorBuilder SourcePoint(Action<DiagramPointBuilder> sourcePoint)

Parameters

Type	Name	Description
System.Action<DiagramPointBuilder>	sourcePoint

Returns

Type
DiagramConnectorBuilder

SourcePortID(String)

Sets the unique id of the source port of the connector

Declaration

public DiagramConnectorBuilder SourcePortID(string sourcePortID)

Parameters

Type	Name	Description
System.String	sourcePortID

Returns

Type
DiagramConnectorBuilder

Style(DiagramStrokeStyle)

Defines the appearance of the connection path

Declaration

public DiagramConnectorBuilder Style(DiagramStrokeStyle style)

Parameters

Type	Name	Description
DiagramStrokeStyle	style

Returns

Type
DiagramConnectorBuilder

Style(Action<DiagramStrokeStyleBuilder>)

Declaration

public DiagramConnectorBuilder Style(Action<DiagramStrokeStyleBuilder> style)

Parameters

Type	Name	Description
System.Action<DiagramStrokeStyleBuilder>	style

Returns

Type
DiagramConnectorBuilder

SymbolInfo(Object)

Defines the symbol info of a connector

Declaration

public DiagramConnectorBuilder SymbolInfo(object symbolInfo)

Parameters

Type	Name	Description
System.Object	symbolInfo

Returns

Type
DiagramConnectorBuilder

TargetDecorator(DiagramDecorator)

Defines the target decorator of the connector

Declaration

public DiagramConnectorBuilder TargetDecorator(DiagramDecorator targetDecorator)

Parameters

Type	Name	Description
DiagramDecorator	targetDecorator

Returns

Type
DiagramConnectorBuilder

TargetDecorator(Action<DiagramDecoratorBuilder>)

Declaration

public DiagramConnectorBuilder TargetDecorator(Action<DiagramDecoratorBuilder> targetDecorator)

Parameters

Type	Name	Description
System.Action<DiagramDecoratorBuilder>	targetDecorator

Returns

Type
DiagramConnectorBuilder

TargetID(String)

Sets the target node/connector object of the connector

Declaration

public DiagramConnectorBuilder TargetID(string targetID)

Parameters

Type	Name	Description
System.String	targetID

Returns

Type
DiagramConnectorBuilder

TargetPadding(Double)

Sets the target padding of the connector

Declaration

public DiagramConnectorBuilder TargetPadding(double targetPadding)

Parameters

Type	Name	Description
System.Double	targetPadding

Returns

Type
DiagramConnectorBuilder

TargetPoint(DiagramPoint)

Sets the end point of the connector

Declaration

public DiagramConnectorBuilder TargetPoint(DiagramPoint targetPoint)

Parameters

Type	Name	Description
DiagramPoint	targetPoint

Returns

Type
DiagramConnectorBuilder

TargetPoint(Action<DiagramPointBuilder>)

Declaration

public DiagramConnectorBuilder TargetPoint(Action<DiagramPointBuilder> targetPoint)

Parameters

Type	Name	Description
System.Action<DiagramPointBuilder>	targetPoint

Returns

Type
DiagramConnectorBuilder

TargetPortID(String)

Sets the unique id of the target port of the connector

Declaration

public DiagramConnectorBuilder TargetPortID(string targetPortID)

Parameters

Type	Name	Description
System.String	targetPortID

Returns

Type
DiagramConnectorBuilder

defines the tooltip for the connector

Declaration

public DiagramConnectorBuilder Tooltip(DiagramDiagramTooltip tooltip)

Parameters

Type	Name	Description
DiagramDiagramTooltip	tooltip

Returns

Type
DiagramConnectorBuilder

Declaration

public DiagramConnectorBuilder Tooltip(Action<DiagramDiagramTooltipBuilder> tooltip)

Parameters

Type	Name	Description
System.Action<DiagramDiagramTooltipBuilder>	tooltip

Returns

Type
DiagramConnectorBuilder

Type(Segments)

Defines the type of the connector Straight - Sets the segment type as Straight Orthogonal - Sets the segment type as Orthogonal Bezier - Sets the segment type as Bezier

Declaration

public DiagramConnectorBuilder Type(Segments type)

Parameters

Type	Name	Description
Segments	type

Returns

Type
DiagramConnectorBuilder

Visible(Boolean)

Sets the visibility of the node/connector

Declaration

public DiagramConnectorBuilder Visible(bool visible)

Parameters

Type	Name	Description
System.Boolean	visible

Returns

Type
DiagramConnectorBuilder

Wrapper(Object)

Defines the UI of the connector

Declaration

public DiagramConnectorBuilder Wrapper(object wrapper)

Parameters

Type	Name	Description
System.Object	wrapper

Returns

Type
DiagramConnectorBuilder

ZIndex(Double)

Defines the visual order of the node/connector in DOM

Declaration

public DiagramConnectorBuilder ZIndex(double zIndex)

Parameters

Type	Name	Description
System.Double	zIndex

Returns

Type
DiagramConnectorBuilder