IPackage Interface

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

Syntax

'Declaration
Public Interface IPackage _
    Inherits INamespace, IPackageableElement, IParameterableElement, INamedElement,  _
    ITemplateableElement, IElement

public interface IPackage : INamespace, 
    IPackageableElement, IParameterableElement, INamedElement, ITemplateableElement, IElement

public interface class IPackage : INamespace, 
    IPackageableElement, IParameterableElement, INamedElement, ITemplateableElement, IElement

type IPackage =  
    interface 
        interface INamespace 
        interface IPackageableElement 
        interface IParameterableElement 
        interface INamedElement 
        interface ITemplateableElement 
        interface IElement 
    end

public interface IPackage extends INamespace, IPackageableElement, IParameterableElement, INamedElement, ITemplateableElement, IElement

The IPackage type exposes the following members.

Properties

	Name	Description
	AllProfileInstances	Gets a list of all Profiles linked to this Package and Profiles recursively inherited from its ancestor owning packages. Stereotypes from these Profiles can be applied to elements inside the Package. In addition, Stereotypes from Profiles in containing packages or models can be applied to elements inside the package.
	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.)
	Members	Gets the elements that are part of this Namespace. (Inherited from INamespace.)
	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.)
	NestedPackages	Gets the Packages owned by this package.
	NestingPackage	Gets the package that owns this package, or null.
	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.)
	OwnedMembers	Gets the elements that are defined within this Namespace. (Inherited from INamespace.)
	OwnedTypes	Gets the PackagedElements that are types.
	Owner	Gets the Element that owns this element. Every element except the root IModel has one owner. (Inherited from IElement.)
	OwningPackage	Gets the package that contains this element. (Inherited from IPackageableElement.)
	OwningTemplateParameter	If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
	PackagedElements	Gets the elements owned by this package.
	PackageImports	Gets the packages that are imported by this namespace. (Inherited from INamespace.)
	ProfileInstances	Gets a list of Profiles linked to this Package. Stereotypes from these Profiles can be applied to elements inside the Package. In addition, Stereotypes from Profiles in containing packages or models can be applied to elements inside the package.
	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.)
	TemplateBindings	Gets the Bindings in which this element is used. (Inherited from ITemplateableElement.)
	TemplateParameter	If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
	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.)
	ApplyProfile	Applies the profile to package, so that the profile's stereotypes can be applied to the package's contents. Creates an IProfileInstance that represents the relationship between the profile and the package. (Defined by ProfileStereotypeExtensions.)
	ApplyStereotype	Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype. (Defined by ProfileStereotypeExtensions.)
	CreateAbstraction	Create a new IAbstraction link in the NamedElement (Defined by PackageExtensions.)
	CreateActivity	Create a new IActivity object in the Package (Defined by PackageExtensions.)
	CreateActor	Create a new IActor object in the Package (Defined by PackageExtensions.)
	CreateArtifact	Create a new IArtifact object in the Package (Defined by PackageExtensions.)
	CreateAssociation	Create a new IAssociation (Defined by PackageExtensions.)
	CreateClass	Create a new IClass object in the Package (Defined by PackageExtensions.)
	CreateComment	Create a new IComment object in the Package (Defined by PackageExtensions.)
	CreateComponent	Create a new IComponent object in the Package (Defined by PackageExtensions.)
	CreateDataType	Create a new IDataType object in the Package (Defined by PackageExtensions.)
	CreateDependency	Create a new IDependency link in the NamedElement (Defined by PackageExtensions.)
	CreateEnumeration	Create a new IEnumeration object in the Package (Defined by PackageExtensions.)
	CreateInteraction	Create a new IInteraction object in the Package (Defined by PackageExtensions.)
	CreateInterface	Create a new IInterface object in the Package (Defined by PackageExtensions.)
	CreateInterfaceRealization	Create a new IInterfaceRealization link in the BehavioredClassifier (Defined by PackageExtensions.)
	CreatePackage	Create a new IPackage object in the Package (Defined by PackageExtensions.)
	CreatePackageImport	Import a package into a namespace. Creates an IPackageImport link to the package. (Defined by NamespaceExtensions.)
	CreatePrimitiveType	Create a new IPrimitiveType object in the Package (Defined by PackageExtensions.)
	CreateRealization	Create a new IRealization link in the NamedElement (Defined by PackageExtensions.)
	CreateSubsystem	Create a new ISubsystem object in the Package (Defined by PackageExtensions.)
	CreateUsage	Create a new IUsage link in the NamedElement (Defined by PackageExtensions.)
	CreateUseCase	Create a new IUseCase object in the Package (Defined by PackageExtensions.)
	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.)
	GetImportedPackages	The imported packages of the namespace (Defined by PackageExtensions.)
	GetImportingNamespaces	The importing namespace of the package (Defined by PackageExtensions.)
	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.Classes Namespace