Class DiagramPortBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
DiagramPortBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class DiagramPortBuilder : ControlBuilder
Constructors
DiagramPortBuilder()
Declaration
public DiagramPortBuilder()
DiagramPortBuilder(List<DiagramPort>)
Declaration
public DiagramPortBuilder(List<DiagramPort> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<DiagramPort> |
collection |
|
Methods
Add()
Declaration
AddInfo(Object)
Allows the user to save custom information/data about a port
Declaration
public DiagramPortBuilder AddInfo(object addInfo)
Parameters
| Type |
Name |
Description |
| System.Object |
addInfo |
|
Returns
ConnectionDirection(PortConnectionDirection)
Defines the allowed direction for connections to the port
Auto - Maintains the default behavior of automatic direction calculation.
Left - Restricts connections to only connect to the left side of the port.
Top - Restricts connections to only connect to the top side of the port.
Right - Restricts connections to only connect to the right side of the port.
Bottom - Restricts connections to only connect to the bottom side of the port.
Declaration
public DiagramPortBuilder ConnectionDirection(PortConnectionDirection connectionDirection)
Parameters
Returns
Constraints(PortConstraints)
Defines the constraints of port
Declaration
public DiagramPortBuilder Constraints(PortConstraints constraints)
Parameters
Returns
Height(Double)
Sets the height of the port
Declaration
public DiagramPortBuilder Height(double height)
Parameters
| Type |
Name |
Description |
| System.Double |
height |
|
Returns
HorizontalAlignment(HorizontalAlignment)
Sets the horizontal alignment of the port with respect to its immediate parent(node/connector)
Stretch - Stretches the diagram element throughout its immediate parent
Left - Aligns the diagram element at the left of its immediate parent
Right - Aligns the diagram element at the right of its immediate parent
Center - Aligns the diagram element at the center of its immediate parent
Auto - Aligns the diagram element based on the characteristics of its immediate parent
Declaration
public DiagramPortBuilder HorizontalAlignment(HorizontalAlignment horizontalAlignment)
Parameters
Returns
Id(String)
Defines the unique id of the port
Declaration
public DiagramPortBuilder Id(string id)
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
Returns
InEdges(String[])
Defines the collection of the objects that are connected to a particular port
Declaration
public DiagramPortBuilder InEdges(string[] inEdges)
Parameters
| Type |
Name |
Description |
| System.String[] |
inEdges |
|
Returns
Margin(DiagramMargin)
Defines the space that the port has to be moved from its actual position
Declaration
public DiagramPortBuilder Margin(DiagramMargin margin)
Parameters
Returns
Margin(Action<DiagramMarginBuilder>)
Declaration
public DiagramPortBuilder Margin(Action<DiagramMarginBuilder> margin)
Parameters
Returns
Offset(DiagramPoint)
Defines the position of the port with respect to the boundaries of nodes/connector
Declaration
public DiagramPortBuilder Offset(DiagramPoint offset)
Parameters
Returns
Offset(Action<DiagramPointBuilder>)
Declaration
public DiagramPortBuilder Offset(Action<DiagramPointBuilder> offset)
Parameters
Returns
OutEdges(String[])
Defines the collection of the objects that are connected to a particular port
Declaration
public DiagramPortBuilder OutEdges(string[] outEdges)
Parameters
| Type |
Name |
Description |
| System.String[] |
outEdges |
|
Returns
PathData(String)
Defines the geometry of the port
Declaration
public DiagramPortBuilder PathData(string pathData)
Parameters
| Type |
Name |
Description |
| System.String |
pathData |
|
Returns
Shape(PortShapes)
Defines the type of the port shape
X - Sets the decorator shape as X
Circle - Sets the decorator shape as Circle
Square - Sets the decorator shape as Square
Custom - Sets the decorator shape as Custom
Declaration
public DiagramPortBuilder Shape(PortShapes shape)
Parameters
Returns
Style(DiagramShapeStyle)
Defines the appearance of the port
Declaration
public DiagramPortBuilder Style(DiagramShapeStyle style)
Parameters
Returns
Style(Action<DiagramShapeStyleBuilder>)
Declaration
public DiagramPortBuilder Style(Action<DiagramShapeStyleBuilder> style)
Parameters
Returns
defines the tooltip for the Ports
Declaration
public DiagramPortBuilder Tooltip(object tooltip)
Parameters
| Type |
Name |
Description |
| System.Object |
tooltip |
|
Returns
VerticalAlignment(VerticalAlignment)
Sets the vertical alignment of the port with respect to its immediate parent(node/connector)
Stretch - Stretches the diagram element throughout its immediate parent
Top - Aligns the diagram element at the top of its immediate parent
Bottom - Aligns the diagram element at the bottom of its immediate parent
Center - Aligns the diagram element at the center of its immediate parent
Auto - Aligns the diagram element based on the characteristics of its immediate parent
Declaration
public DiagramPortBuilder VerticalAlignment(VerticalAlignment verticalAlignment)
Parameters
Returns
Visibility(PortVisibility)
Defines the type of the port visibility
Visible - Always shows the port
Hidden - Always hides the port
Hover - Shows the port when the mouse hovers over a node
Connect - Shows the port when a connection end point is dragged over a node
Declaration
public DiagramPortBuilder Visibility(PortVisibility visibility)
Parameters
Returns
Width(Double)
Sets the width of the port
Declaration
public DiagramPortBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
