Altova UModel 2025 Professional Edition

Navigation: UModel Programmer's Reference > UModel API Reference > UMLData Interfaces > IUMLGuiElement

UModelAPI - IUMLGuiLineLink

Home Prev Top Next

Interface IUMLGuiLineLink

diagram

hierarchy

typedElements

Interface IUMLDataAll	Operation	AddUMLGuiNoteLinkToLine AddUMLLineElement
Interface IUMLGuiDiagram	Operation	AddUMLGuiNoteLinkToLine AddUMLLineElement

documentation

This interface represents a line on a diagram. There are some special lines deriving from this interface available as well.

A line is composed of multiple but at least 2 waypoints which are connected to each other, which can be accessed using the AllWaypoints property. Two of these waypoints are usually of type IUMLGuiEndWaypoint. There may be also a Middlewaypoint accessible with the property MiddleWaypoint which can be used for example to access textlabels and a LineConnectionWaypoint when the line is connected to another line, like to a IUMLGuiNoteLink.

The LineBegin property refers the first object and LineEnd property refers the second graphical object which the line connects.

Operation IUMLGuiLineLink::AllWaypoints

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLDataList

documentation

A derived list of all waypoints which are part of this line. All elements in this list are of type (or subtype of) IUMLGuiWaypoint.

Operation IUMLGuiLineLink::EraseWaypointAt

parameter

name	direction	type	type modifier	multiplicity	default
nIdx	in	int
return	return	void

Operation IUMLGuiLineLink::InsertWaypointAt

parameter

name	direction	type	type modifier	multiplicity	default
nIdx	in	int
return	return	IUMLGuiWaypoint

Operation IUMLGuiLineLink::LineBegin

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiElement

documentation

A reference to the first object, where the line starts.

Operation IUMLGuiLineLink::LineConnectionWaypoints

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLDataList

documentation

A list of all waypoints which connect the line with other lines. All elements in this list are of type (or subtype of) IUMLGuiWaypoint.

Operation IUMLGuiLineLink::LineEnd

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiElement

documentation

A reference to the second object, where the line ends.

Operation IUMLGuiLineLink::MiddleWaypoint

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiMiddleWaypoint

Operation IUMLGuiLineLink::Waypoints

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLDataList

documentation

A list of all waypoints which form the vertices of this line. All elements in this list are of type (or subtype of) IUMLGuiWaypoint.

UML documentation generated by UModel UML Editor https://www.altova.com/umodel

Wed Sep 25 10:33:04 2024