IDiagram Interface


Represents a UML modeling diagram. It is a supertype of the specific diagram types such as IClassDiagram. Each diagram is represented as a pair of files in the model.

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


public interface IDiagram : IShape
public interface class IDiagram : IShape
type IDiagram = 
        interface IShape
Public Interface IDiagram
    Inherits IShape


Name Description
System_CAPS_pubproperty 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.)

System_CAPS_pubproperty Color

Gets or sets the color of the shape. (Inherited from IShape.)

System_CAPS_pubproperty Diagram

The diagram that contains this shape.(Inherited from IShape.)

System_CAPS_pubproperty 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.

System_CAPS_pubproperty Height

(Inherited from IShape.)

System_CAPS_pubproperty ModelStore

The UML model store which contains the diagram and the model that it shows.

System_CAPS_pubproperty Name

The name of the diagram. It is not always the same as the file name.

System_CAPS_pubproperty 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.)

System_CAPS_pubproperty 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.

System_CAPS_pubproperty TypeName

A string indicating what kind of diagram this is, such as "ComponentDiagram".

System_CAPS_pubproperty Width

(Inherited from IShape.)

System_CAPS_pubproperty XPosition

(Inherited from IShape.)

System_CAPS_pubproperty YPosition

(Inherited from IShape.)


Name Description
System_CAPS_pubmethod 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.)

System_CAPS_pubmethod EnsureVisible(IEnumerable<IShape>, Boolean)

System_CAPS_pubmethod GetObject<T>()

Gets the model element represented by this shape. Supply the type of the result that you want.(Inherited from IShape.)

System_CAPS_pubmethod Move(Double, Double, Double, Double)

Changes the position and size of the shape.(Inherited from IShape.)

System_CAPS_pubmethod 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.

System_CAPS_pubmethod ToIShape<T>()

Cast to a type that specifies the type of the element that the shape represents.(Inherited from IShape.)

Extension Methods

Name Description
System_CAPS_pubmethod GetChildShapes<T>()

Get child shapes that display the specified type of model element.(Defined by PresentationHelpers.)

System_CAPS_pubmethod GetElement()

The model element that this shape represents.(Defined by IShapeExtensions.)

System_CAPS_pubmethod GetSelectedShapes<T>()

Get all the selected shapes that display UML model elements of the specified type.(Defined by PresentationHelpers.)

System_CAPS_pubmethod 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.)


For more information, see the following topics:

See Also

Microsoft.VisualStudio.ArchitectureTools.Extensibility.Presentation Namespace

Return to top