Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
Connector Class
To represent the various kinds of connectors between UML elements, use a Connector object. You can access this from either the Client or Supplier element, using the Connectors collection of that element. When creating a new connector you assign it a valid type from the following list:
• | Aggregation |
• | Assembly |
• | Association |
• | Collaboration |
• | CommunicationPath |
• | Connector |
• | ControlFlow |
• | Delegate |
• | Dependency |
• | Deployment |
• | ERLink |
• | Generalization |
• | InformationFlow |
• | Instantiation |
• | InterruptFlow |
• | Manifest |
• | Nesting |
• | NoteLink |
• | ObjectFlow |
• | Package |
• | Realization |
• | Sequence |
• | StateFlow |
• | TemplateBinding |
• | UseCase |
Associated table in .EAP file t_connector
Connector Attributes
Attribute |
Type |
Notes |
See also |
||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Alias |
String |
Read/Write An optional alias for this connector.
|
|
||||||||
ClientEnd |
ConnectorEnd |
Read only A pointer to the ConnectorEnd object representing the source end of the relationship.
|
|||||||||
ClientID |
Long |
Read/Write The ElementID of the element at the source end of this connector.
|
|
||||||||
Color |
Long |
Read/Write Sets the color of the connector.
|
|
||||||||
ConnectorGUID |
Variant |
Read only A system generated, globally unique ID for the current connector.
|
|
||||||||
ConnectorID |
Long |
Read only A system generated local identifier for the current connector.
|
|
||||||||
Constraints |
Collection |
Read only A collection of constraint objects.
|
|||||||||
ConveyedItems |
Collection |
Read only Returns a collection of elements that have been conveyed. To add another element to the conveyed Collection, use AddNew (ElementGUID,NULL); where ElementGUID is the GUID of the element to be added.
|
|||||||||
CustomProperties |
Collection |
Read only Returns a collection of advanced properties associated with an element in the form of CustomProperty objects.
|
|||||||||
DiagramID |
Long |
Read/Write The DiagramID of the connector.
|
|
||||||||
Direction |
String |
Read/Write The connector direction, which can be set to one of the following:
If the connector is non-navigable, set the sourceNavigability and/or targetNavigability attributes.
|
|||||||||
EndPointX |
Long |
Read/Write The x-coordinate of the connector's end point. Connector end points are specified in Cartesian coordinates with the origin to the top left of the screen.
|
|
||||||||
EndPointY |
Long |
Read/Write The y-coordinate of the connector's end point. Connector end points are specified in Cartesian coordinates with the origin to the top left of the screen.
|
|
||||||||
EventFlags |
String |
Read/Write A structure to hold a variety of flags concerned with event signaling on messages.
|
|
||||||||
IsLeaf |
Boolean |
Read/Write A flag indicating that the connector is a leaf.
|
|
||||||||
IsRoot |
Boolean |
Read/Write A flag indicating that the connector is a root.
|
|
||||||||
IsSpec |
Boolean |
Read/Write. A flag indicating that the connector is a specification.
|
|
||||||||
MetaType |
String |
Read only The connector's domain-specific meta type, as defined by an applied stereotype from an MDG Technology
|
|
||||||||
MiscData |
String |
Read only This low-level property returns an array providing information about the contents of the PDatax fields; these database fields are not documented and developers must gain understanding of these fields through their own endeavors to use this property. MiscData is zero based, therefore:
and so on.
|
|
||||||||
Name |
String |
Read/Write The connector name.
|
|
||||||||
Notes |
String |
Read/Write Descriptive notes about the connector.
|
|
||||||||
ObjectType |
ObjectType |
Read only Distinguishes objects referenced through a Dispatch interface.
|
|||||||||
Properties |
Properties |
Returns a list of specialized properties applicable to the connector that might not be available using the automation model. The properties are purposely undocumented because of their obscure nature and because they are subject to change as progressive enhancements are made to them.
|
|||||||||
RouteStyle |
Long |
Read/Write The route style.
|
|
||||||||
SequenceNo |
Long |
Read/Write The SequenceNo of the connector.
|
|
||||||||
StartPointX |
Long |
Read/Write The x-coordinate of the connector's start point. Connector end points are specified in Cartesian coordinates with the origin to the top left of the screen.
|
|
||||||||
StartPointY |
Long |
Read/Write The y-coordinate of the connector's start point. Connector end points are specified in Cartesian coordinates with the origin to the top left of the screen.
|
|
||||||||
StateFlags |
String |
Read/Write. A structure to hold a variety of flags concerned with State signaling on messages; the list is delimited by semi-colons.
|
|
||||||||
Stereotype |
String |
Read/Write Sets or gets the stereotype for this connector end.
|
|
||||||||
StereotypeEx |
String |
Read/Write All the applied stereotypes of the connector in a comma-separated list.
|
|
||||||||
StyleEx |
String |
Read/Write Advanced style settings; reserved for the use of Sparx Systems.
|
|
||||||||
Subtype |
String |
Read/Write A possible subtype to refine the meaning of the connector.
|
|
||||||||
SupplierEnd |
ConnectorEnd |
Read only A pointer to the ConnectorEnd object representing the target end of the relationship.
|
|||||||||
SupplierID |
Long |
Read/Write The ElementID of the element at the target end of this connector.
|
|
||||||||
TaggedValues |
Collection of type ConnectorTag |
Read only The collection of ConnectorTag objects.
|
|||||||||
TransitionAction |
String |
Read/Write See the Transition topic for appropriate values.
|
|
||||||||
TransitionEvent |
String |
Read/Write See the Transition topic for appropriate values.
|
|||||||||
TransitionGuard |
String |
Read/Write See the Transition topic for appropriate values.
|
|||||||||
Type |
String |
Read/Write The connector type; valid types are held in the t_connectortypes table in the
|
|
||||||||
VirtualInheritance |
String |
Read/Write For Generalization, indicates if the inheritance is virtual.
|
|
||||||||
Width |
Long |
Read/Write Specifies the width of the connector.
|
|
Connector Methods
Method |
Type |
Notes |
---|---|---|
GetLastError () |
String |
Returns a string value describing the most recent error that occurred in relation to this object.
|
Update () |
Boolean |
Update the current ConnectorObject after modification or appending a new item. If false is returned, check the GetLastError function for more information.
|