public Class
A ConnectorObject represents the various kinds of connectors between UML elements. It is accessed from either the Client or Supplier element, using the Connectors collection of that element. When creating a new connector you must assign it a valid type from the following list:
· | Aggregation |
· | Association |
· | Collaboration |
· | Dependency |
· | Generalization |
· | Instantiation |
· | Nesting |
· | NoteLink |
· | Realisation |
· | Sequence |
· | Transition |
· | UseCase |
Associated table in .EAP file: t_connector
Connector Attributes
Attribute |
Type |
Notes |
||||||||
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. 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 globally unique ID for the current connector. System generated. |
||||||||
ConnectorID |
Long |
Read only. Local identifier for the current connector. System generated. |
||||||||
Constraints |
Collection |
Read only. Collection of constraint objects. |
||||||||
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. Connector direction. Can be set to one of the following:
|
||||||||
EventFlags |
String |
Read/Write. Structure to hold a variety of flags concerned with event signaling on messages. |
||||||||
IsLeaf |
Boolean |
Read/Write. Flag indicating connector is a leaf. |
||||||||
IsRoot |
Boolean |
Read/Write. Flag indicating connector is a root. |
||||||||
IsSpec |
Boolean |
Read/Write. Flag indicating 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. |
||||||||
Name |
String |
Read/Write. The connector name. |
||||||||
Notes |
String |
Read/Write. Descriptive notes about the connector. |
||||||||
ObjectType |
Read only. Distinguishes objects referenced through a Dispatch interface. |
|||||||||
Properties |
Returns a list of specialized properties that apply 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. |
||||||||
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. Not currently used. |
||||||||
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. ElementID of the element at the target end of this connector. |
||||||||
TaggedValues |
Collection |
Read only. Collection of ConnectorTag objects. |
||||||||
TransitionEvent |
String |
Read/Write. See the Transition topic in the Enterprise Architect User Guide for appropriate values. |
||||||||
TransitionGuard |
String |
Read/Write. See the Transition topic in the Enterprise Architect User Guide for appropriate values. |
||||||||
TransitionAction |
String |
Read/Write. See the Transition topic in the Enterprise Architect User Guide for appropriate values. |
||||||||
Type |
String |
Read/Write. Connector type. Valid types are held in the t_connectortypes table in the .EAP file. |
||||||||
VirtualInheritance |
String |
Read/Write. For Generalization, indicates if inheritance is virtual. |
||||||||
Width |
Long |
Read/Write. Specifies the width of the connector. |
Connector Methods
Method |
Type |
Notes |
Update () |
Boolean |
Update the current ConnectorObject after modification or appending a new item. If false is returned, check the GetLastError function for more information. |
GetLastError () |
String |
Returns a string value describing the most recent error that occurred in relation to this object. This function is rarely used since an exception is thrown when an error occurs. |