diagConnector (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Properties specific to the description of diagConnector variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Diagram functions

diagConnector (Type of variable)

In french: diagLien

Inherits from diagShape (Type of variable)

Warning
From version 27 (77), diagLink is kept for backward compatibility. This function is replaced by diagConnector.

The diagConnector type is used to define all the advanced characteristics of a connector in a diagram. The characteristics of this connector can be defined and changed using different WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

N is int

// Create a rectangle shape
MyShape1 is diagRectangle
// Set the dimensions, position and background color
MyShape1.X = 100
MyShape1.Y = 100
MyShape1.Width = 50
MyShape1.Height = 50
MyShape1.Background.Color = PastelRed

// Reference the displayed diagram
MyDiagram is Diagram <- DIAGEDT_MyDiagram

// Add the rectangle shape to the diagram
N = Add(MyDiagram.Shape, MyShape1)

// Create an ellipse
MyShape2 is diagOval

// Set the dimensions, position and background color
MyShape2.X = 200
MyShape2.Y = 200
MyShape2.Width = 50
MyShape2.Height = 50
MyShape2.Background.Color = PastelGreen

// Add the ellipse to the diagram
Add(MyDiagram.Shape, MyShape2)

// Creates a link
MyConnector is diagConnector
Add(MyDiagram.Shape, MyConnector)

// Reference added objects
MyShape1 <- MyDiagram.Shape[ N ]
MyShape2 <- MyDiagram.Shape[ N + 1 ]
MyConnector <- MyDiagram.Shape[ N + 2 ]

MyConnector.Beginning.ConnectionPoint = MyShape1.ConnectionPoint[1]
MyConnector.Beginning.ConnectionPoint.X = 100
MyConnector.Beginning.ConnectionPoint.Y = 50

MyConnector.Ending.ConnectionPoint = MyShape2.ConnectionPoint[1]
MyConnector.Ending.ConnectionPoint.X = 0
MyConnector.Ending.ConnectionPoint.Y = 50

Properties

Properties specific to the description of diagConnector variables

Remark: The diagConnector type inherits from the diagShape type. This means all the properties of the diagShape type are available for the diagConnector type. These properties appear in italics in the list below.

The following properties can be used to handle a connector:

Property name	Type used	Effect

New in version 28 ActionAllowed	diagActionAllowed or constant	diagActionAllowed variable used to define the actions available to the end user. diagActionNone constant: no action available. diagActionAll constant (Default value): all actions are available.
Angle	Real	Angle of rotation of the shape (expressed in degrees).
Background		Background color of the shape. The Color property is used to define the background color of the shape. This property can correspond to: an RGB color (returned by RGB), an HSL color (returned by HSL), a WLanguage preset color. a variable of type Color. In this case, the opacity specified in the variable is taken into account.
Border	diagBorder	Characteristics of the shape border. The available properties are: Color: color of the border. Thickness: Thickness of border. Type: Border type.
Comment	Character string	Note about the shape. This note is not displayed.
ConnectionPoint	Array of diagConnectionPoint	List of connection points of the shape.
Ending	diagHead	Target end of the connector.
Height	Real	Height of the box that contains the shape before rotation or zoom, expressed in pixels.
Name	Character string	Shape name. This name will be used for searching, for example, if the shape is in a library.
Note	Character string	Note associated with the shape.
Opacity	Integer	Percentage of opacity of the shape. This value ranges from invisible (0) to completely opaque (100).
Routing	Integer constant	Type of route taken by the connector: routeStraight: The connector, which goes from the start point to the end point and passes through the waypoints, is a straight line. routeOrthogonal: The connector, which goes from the start point to the end point and passes through the waypoints, has right-angled bends.
Shadow	Boolean	True if the shape has a shadow, False otherwise.
Start	diagHead	Source end of the connector.
Text	diagText	Text (with formatting) inside the shape.
WayPoint	Array of diagWaypoint	Connector waypoints.
Width	Real	Width of the box that contains the shape before rotation or zoom, expressed in pixels.
X	Real	X-coordinate of the box that contains the shape before rotation or zoom, expressed in pixels. This X-coordinate is relative to the parent of the shape.
Y	Real	Y-coordinate of the box that contains the shape before rotation or zoom, expressed in pixels. This Y-coordinate is relative to the parent of the shape.