Altova UModel 2025 Professional Edition

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

UModelAPI - IUMLGuiDiagram

Home Prev Top Next

Interface IUMLGuiDiagram

diagram

hierarchy

typedElements

Interface IDiagramWindow	Operation	Diagram
Interface IDocument	Operation	OpenDiagram
Interface IUMLDataAll	Operation	InsertOwnedDiagramAt ReferencedDiagram
Interface IUMLGuiRootElement	Operation	InsertOwnedDiagramAt
Interface IUMLGuiSubDiagramNode	Operation	ReferencedDiagram

documentation

Represents an UML diagram and contains all layers, nodes (represented as IUMLGuiNodeLink) and lines (represented as IUMLGuiLineLink).Use the property GuiLinks to access these.

Operation IUMLGuiDiagram::ActiveLayer

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiDiagramLayer

Operation IUMLGuiDiagram::AddUMLElement

parameter

name	direction	type	type modifier	multiplicity	default
strKind	in	string
nLeft	in	int
nTop	in	int
return	return	IUMLGuiNodeLink

documentation

Adds a new UML element (e.g. IUMLClass, IUMLPackage,...) to the model and shows it with a new IUMLGuiNodeLink on the diagram.

Operation IUMLGuiDiagram::AddUMLGuiContainmentLink

parameter

name	direction	type	type modifier	multiplicity	default
ipFromLink	in	IUMLGuiLink
ipToLink	in	IUMLGuiLink
return	return	IUMLGuiContainmentLink

Operation IUMLGuiDiagram::AddUMLGuiNodeLink

parameter

name	direction	type	type modifier	multiplicity	default
ipForUMLData	in	IUMLData
nLeft	in	int
nTop	in	int
return	return	IUMLGuiNodeLink

documentation

Adds a new IUMLGuiNodeLink for an existing UML element (e.g. IUMLClass, IUMLPackage,...) on the diagram.

Operation IUMLGuiDiagram::AddUMLGuiNote

parameter

name	direction	type	type modifier	multiplicity	default
nLeft	in	int
nTop	in	int
return	return	IUMLGuiNote

Operation IUMLGuiDiagram::AddUMLGuiNoteLink

parameter

name	direction	type	type modifier	multiplicity	default
ipFromNote	in	IUMLGuiNote
ipToLink	in	IUMLGuiNodeLink
return	return	IUMLGuiNoteLink

Operation IUMLGuiDiagram::AddUMLGuiNoteLinkToLine

parameter

name	direction	type	type modifier	multiplicity	default
ipFromNote	in	IUMLGuiNote
ipToLink	in	IUMLGuiLineLink
nDistanceFromLineBegin	in	int
return	return	IUMLGuiNoteLink

Operation IUMLGuiDiagram::AddUMLLineElement

parameter

name	direction	type	type modifier	multiplicity	default
strKind	in	string
ipFromNode	in	IUMLGuiNodeLink
ipToNode	in	IUMLGuiNodeLink
return	return	IUMLGuiLineLink

documentation

Adds a new UML line element (e.g. IUMLGeneralization, IUMLAssociation,...) to the model and shows it with a new IUMLGuiLineLink on the diagram.

Operation IUMLGuiDiagram::Comment

parameter

name	direction	type	type modifier	multiplicity	default
return	return	string

Operation IUMLGuiDiagram::EraseFromDiagram

parameter

name	direction	type	type modifier	multiplicity	default
ipVal	in	IUMLGuiElement
return	return	void

documentation

Use this function to erase the element from the diagram only.

Use IUMLElement::EraseFromModel to erase from the model and all diagrams.

Operation IUMLGuiDiagram::EraseFromModel

parameter

name	direction	type	type modifier	multiplicity	default
return	return	void

Operation IUMLGuiDiagram::GuiLinks

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLDataList

documentation

A list of elements of type IUMLGuiLink which are displayed directly on this diagram. Usually, these are IUMLGuiNodeLinks and IUMLGuiLineLinks.

Operation IUMLGuiDiagram::InsertLayerAt

parameter

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

Operation IUMLGuiDiagram::InsertOwnedGuiTextHyperlinkAt

parameter

name	direction	type	type modifier	multiplicity	default
nFromTextPos	in	int
nToTextPos	in	int
strAddress	in	string
return	return	IUMLGuiTextHyperlink

Operation IUMLGuiDiagram::Layers

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLDataList

documentation

A list of all layers in the diagam. The list contains elements of type IUMLGuiDiagramLayer.

Operation IUMLGuiDiagram::LinkedOwner

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLElement

Operation IUMLGuiDiagram::MergeLayersAt

parameter

name	direction	type	type modifier	multiplicity	default
nFromIdx	in	int
nToIdx	in	int
return	return	void

Operation IUMLGuiDiagram::Name

parameter

name	direction	type	type modifier	multiplicity	default
return	return	string

Operation IUMLGuiDiagram::OwnedHyperlinks

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLDataList

Operation IUMLGuiDiagram::SetName

parameter

name	direction	type	type modifier	multiplicity	default
strStartWith	in	string
return	return	string

Operation IUMLGuiDiagram::ZoomFactor

parameter

name	direction	type	type modifier	multiplicity	default
return	return	int

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

Wed Sep 25 10:33:04 2024