IDiagram Interface

  • Article

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)

Syntax

'Declaration
Public Interface IDiagram _
    Inherits IShape

public interface IDiagram : IShape

public interface class IDiagram : IShape

type IDiagram =  
    interface
        interface IShape
    end

public interface IDiagram extends IShape

The IDiagram type exposes the following members.

Properties

  Name Description
Public property 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.)
Public property Color Gets or sets the color of the shape. (Inherited from IShape.)
Public property Diagram The diagram that contains this shape. (Inherited from IShape.)
Public property 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.
Public property Height (Inherited from IShape.)
Public property ModelStore The UML model store which contains the diagram and the model that it shows.
Public property Name The name of the diagram. It is not always the same as the file name.
Public property 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.)
Public property 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.
Public property TypeName A string indicating what kind of diagram this is, such as "ComponentDiagram".
Public property Width (Inherited from IShape.)
Public property XPosition (Inherited from IShape.)
Public property YPosition (Inherited from IShape.)

Top

Methods

  Name Description
Public method 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.)
Public method EnsureVisible
Public method GetObject<T> Gets the model element represented by this shape. Supply the type of the result that you want. (Inherited from IShape.)
Public method Move Changes the position and size of the shape. (Inherited from IShape.)
Public method SelectShapes 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.
Public method ToIShape<T> Cast to a type that specifies the type of the element that the shape represents. (Inherited from IShape.)

Top

Extension Methods

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

Top

Remarks

For more information, see the following topics:

See Also

Reference

Microsoft.VisualStudio.ArchitectureTools.Extensibility.Presentation Namespace