IComponentDiagram Interface

Article
09/30/2015

Represents a UML component diagram, which can display components and their internal parts, and the connections and dependencies between them. The diagram itself does not form part of the model. It contains IShape objects that represent views of the model elements. Each UML component may be represented by several IShapes, which may be on different diagrams.

Namespace: Microsoft.VisualStudio.ArchitectureTools.Extensibility.Presentation
Assembly: Microsoft.VisualStudio.ArchitectureTools.Extensibility (in Microsoft.VisualStudio.ArchitectureTools.Extensibility.dll)

Syntax

public interface IComponentDiagram : IDiagram, IShape

public interface class IComponentDiagram : IDiagram, IShape

type IComponentDiagram = 
    interface
        interface IDiagram
        interface IShape
    end

Public Interface IComponentDiagram
    Inherits IDiagram, IShape

Properties

	Name	Description
	ChildShapes	Shapes that are contained within this shape. For example, the attribute and operation rows of a class shape; class shapes contained inside a package shape; ports and parts inside a component. For each ChildShape, ParentShape == this.(Inherited from IShape.)
	Color	Gets or sets the color of the shape. (Inherited from IShape.)
	Diagram	The diagram that contains this shape.(Inherited from IShape.)
	FileName	The path of the modeling project file on which the diagram is stored. This is the name of the principal of the two files.(Inherited from IDiagram.)
	Height	(Inherited from IShape.)
	ModelStore	The UML model store which contains the diagram and the model that it shows. (Inherited from IDiagram.)
	Name	The name of the diagram. It is not always the same as the file name.(Inherited from IDiagram.)
	ParentShape	The shape that contains this shape, or null. If ParentShape is not null, this shape is a member of ParentShape.ChildShapes.(Inherited from IShape.)
	SelectedShapes	The collection of shapes that are currently selected. If no individual shape is selected, the collection will contain the diagram as its only member. If other shapes are selected, the diagram will not appear in the collection.(Inherited from IDiagram.)
	TypeName	A string indicating what kind of diagram this is, such as "ComponentDiagram". (Inherited from IDiagram.)
	Width	(Inherited from IShape.)
	XPosition	(Inherited from IShape.)
	YPosition	(Inherited from IShape.)

Methods

	Name	Description
	Delete()	Removes the shape from the diagram. This might or might not remove from the model the element that the shape displays. For example, removing a class shape from a class diagram does not remove the UML class from the model.(Inherited from IShape.)
	Display<T>(T, Double, Double)	Display a UML component on the class diagram. Creates an IShape whose Element is element. The parts and ports of the component are automatically displayed.
	EnsureVisible(IEnumerable<IShape>, Boolean)	(Inherited from IDiagram.)
	GetObject<T>()	Gets the model element represented by this shape. Supply the type of the result that you want.(Inherited from IShape.)
	Move(Double, Double, Double, Double)	Changes the position and size of the shape.(Inherited from IShape.)
	SelectShapes(IEnumerable<IShape>)	Sets the current selection to the given collection of shapes, and sets the Selection property. This does not activate the window that displays the diagram. (Inherited from IDiagram.)
	ToIShape<T>()	Cast to a type that specifies the type of the element that the shape represents.(Inherited from IShape.)

Extension Methods

	Name	Description
	GetChildShapes<T>()	Get child shapes that display the specified type of model element.(Defined by PresentationHelpers.)
	GetElement()	The model element that this shape represents.(Defined by IShapeExtensions.)
	GetSelectedShapes<T>()	Get all the selected shapes that display UML model elements of the specified type.(Defined by PresentationHelpers.)
	SelectShapes(IShape[])	Select a collection of shapes on the diagram. The shapes must be selectable. The diagram's SelectedShapes property will be updated.(Defined by PresentationHelpers.)

Remarks

For more information, see the following topics: