IInclude Interface

An include relationship defines that a use case contains the behavior defined in another use case. Typically used to separate a common series of steps into a single definition. One use case can be included in several other cases.

Namespace:  Microsoft.VisualStudio.Uml.UseCases
Assembly:  Microsoft.VisualStudio.Uml.Interfaces (in Microsoft.VisualStudio.Uml.Interfaces.dll)

Syntax

'Declaration
Public Interface IInclude _
    Inherits IDirectedRelationship, IRelationship, INamedElement, IElement

public interface IInclude : IDirectedRelationship, 
    IRelationship, INamedElement, IElement

public interface class IInclude : IDirectedRelationship, 
    IRelationship, INamedElement, IElement

type IInclude =  
    interface 
        interface IDirectedRelationship 
        interface IRelationship 
        interface INamedElement 
        interface IElement 
    end

public interface IInclude extends IDirectedRelationship, IRelationship, INamedElement, IElement

The IInclude type exposes the following members.

Properties

	Name	Description
	Addition
	ApplicableStereotypes	The set of stereotypes that could be applied to this element. (Inherited from IElement.)
	AppliedStereotypes	Each IStereotypeInstance denotes that a stereotype has been applied to this element. (Inherited from IElement.)
	ClientDependencies	Gets the Dependency relationships for which this element is the Client. (Inherited from INamedElement.)
	Description	The description of this element. (Inherited from IElement.)
	IncludingCase
	Name	The name of this element within the Namespace that contains it. In this Namespace, there should be no other element that has this Name. (Inherited from INamedElement.)
	Namespace	Gets the Namespace in which this element is defined. May be null. (Inherited from INamedElement.)
	OwnedComments	Gets Comments contained in this element (not comments linked to it). (Inherited from IElement.)
	OwnedElements	Gets Elements owned by this element. Every element has one owner, except the root IModel. (Inherited from IElement.)
	Owner	Gets the Element that owns this element. Every element except the root IModel has one owner. (Inherited from IElement.)
	QualifiedName	Gets the name of this element, prefixed with the Qualified Name of the Namespace that contains it. Empty if the Name is empty or if the Qualified Name of the Namespace is empty. (Inherited from INamedElement.)
	Source	The source element of the relationship. (Inherited from IDirectedRelationship.)
	SourceElement	Source element of the relationship. (Inherited from IRelationship.)
	Target	The target element of the relationship. (Inherited from IDirectedRelationship.)
	TargetElement	Target element of the relationship. (Inherited from IRelationship.)
	Visibility	Defines where the element can be referenced. Public = visible anywhere; private = visible only in the owning Namespace; protected = visible to elements that have a generalization relationship to the owning Namespace; package = visible only in the Package owning the Namespace, if there is one. Default = public. (Inherited from INamedElement.)
	VisibleAppliedStereotypes	(Inherited from IElement.)

Top

Extension Methods

	Name	Description
	AddReference	Links a string to an element, usually where the string is a reference such as a URI, modelbus reference, or work item ID. Use the name to indicate the type of reference. Returns an IReference object that represents the link. (Defined by UmlExtensions.)
	ApplyStereotype	Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype. (Defined by ProfileStereotypeExtensions.)
	Delete	Deletes this element and any relationships, owned elements, and shapes. (Defined by UmlExtensions.)
	DeleteAllReference	Remove all the references of a given tag. (Defined by UmlExtensions.)
	GetDependencyClients	Return a collection of elements that are dependent on this. (Defined by NamedElementExtensions.)
	GetDependencySuppliers	Return a collection of elements on which this is dependent. (Defined by NamedElementExtensions.)
	GetId	Gets a GUID that identifies this element. (Defined by UmlExtensions.)
	GetModelStore	Gets the IModelStore that contains this element. (Defined by UmlExtensions.)
	GetReferences	Get the IReferences of a given tag that are associated with this element. (Defined by UmlExtensions.)
	GetRelatedElements<T>	Gets elements related to this element by relationships of the specified type. (Defined by UmlExtensions.)
	GetRelatedLinks<T>	Gets relationships of a specified type from or to this element. (Defined by UmlExtensions.)
	Shapes	All the shapes that display the model element on any open diagram, or on a specified open diagram. (Defined by PresentationHelpers.)

Top

Remarks

Note

The methods defined on this type are extension methods. To use the methods, you must add a project reference to the .NET assembly Microsoft.VisualStudio.ArchitectureTools.Extensibility.dll, and you must include the directive using Microsoft.VisualStudio.ArchitectureTools.Extensibility.Uml; in your code.

See Also

Reference

Microsoft.VisualStudio.Uml.UseCases Namespace