IPackage Interface

  • Article

 

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

Syntax

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

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

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

Public Interface IPackage
    Inherits INamespace, INamedElement, IElement, IPackageableElement,
    IParameterableElement, ITemplateableElement

Properties

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

The set of stereotypes that could be applied to this element. (Inherited from IElement.)
System_CAPS_pubproperty AppliedStereotypes

Each IStereotypeInstance denotes that a stereotype has been applied to this element.(Inherited from IElement.)
System_CAPS_pubproperty ClientDependencies

Gets the Dependency relationships for which this element is the Client. (Inherited from INamedElement.)
System_CAPS_pubproperty Description

The description of this element. (Inherited from IElement.)
System_CAPS_pubproperty Members

Gets the elements that are part of this Namespace. (Inherited from INamespace.)
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty Namespace

Gets the Namespace in which this element is defined. May be null. (Inherited from INamedElement.)
System_CAPS_pubproperty NestedPackages

Gets the Packages owned by this package.
System_CAPS_pubproperty NestingPackage

Gets the package that owns this package, or null.
System_CAPS_pubproperty OwnedComments

Gets Comments contained in this element (not comments linked to it). (Inherited from IElement.)
System_CAPS_pubproperty OwnedElements

Gets Elements owned by this element. Every element has one owner, except the root IModel.(Inherited from IElement.)
System_CAPS_pubproperty OwnedMembers

Gets the elements that are defined within this Namespace. (Inherited from INamespace.)
System_CAPS_pubproperty OwnedTypes

Gets the PackagedElements that are types.
System_CAPS_pubproperty Owner

Gets the Element that owns this element. Every element except the root IModel has one owner.(Inherited from IElement.)
System_CAPS_pubproperty OwningPackage

Gets the package that contains this element. (Inherited from IPackageableElement.)
System_CAPS_pubproperty OwningTemplateParameter

If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
System_CAPS_pubproperty PackagedElements

Gets the elements owned by this package.
System_CAPS_pubproperty PackageImports

Gets the packages that are imported by this namespace. (Inherited from INamespace.)
System_CAPS_pubproperty 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.
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty TemplateBindings

Gets the Bindings in which this element is used. (Inherited from ITemplateableElement.)
System_CAPS_pubproperty TemplateParameter

If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty VisibleAppliedStereotypes

(Inherited from IElement.)

Extension Methods

Name Description
System_CAPS_pubmethod AddReference(String, String, Boolean)

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.)
System_CAPS_pubmethod ApplyProfile(IProfile)

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.)
System_CAPS_pubmethod ApplyStereotype(IStereotype)

Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype.(Defined by ProfileStereotypeExtensions.)
System_CAPS_pubmethod CreateAbstraction(INamedElement, INamedElement)

Create a new IAbstraction link in the NamedElement(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateActivity()

Create a new IActivity object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateActor()

Create a new IActor object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateArtifact()

Create a new IArtifact object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateAssociation(IClassifier, IClassifier)

Create a new IAssociation(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateClass()

Create a new IClass object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateComment()

Create a new IComment object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateComponent()

Create a new IComponent object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateDataType()

Create a new IDataType object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateDependency(INamedElement, INamedElement)

Create a new IDependency link in the NamedElement(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateEnumeration()

Create a new IEnumeration object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateInteraction()

Create a new IInteraction object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateInterface()

Create a new IInterface object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateInterfaceRealization(IBehavioredClassifier, IInterface)

Create a new IInterfaceRealization link in the BehavioredClassifier(Defined by PackageExtensions.)
System_CAPS_pubmethod CreatePackage()

Create a new IPackage object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreatePackageImport(IPackage)

Import a package into a namespace. Creates an IPackageImport link to the package.(Defined by NamespaceExtensions.)
System_CAPS_pubmethod CreatePrimitiveType()

Create a new IPrimitiveType object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateRealization(INamedElement, INamedElement)

Create a new IRealization link in the NamedElement(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateSubsystem()

Create a new ISubsystem object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateUsage(INamedElement, INamedElement)

Create a new IUsage link in the NamedElement(Defined by PackageExtensions.)
System_CAPS_pubmethod CreateUseCase()

Create a new IUseCase object in the Package(Defined by PackageExtensions.)
System_CAPS_pubmethod Delete()

Deletes this element and any relationships, owned elements, and shapes.(Defined by UmlExtensions.)
System_CAPS_pubmethod DeleteAllReference(String)

Remove all the references of a given tag.(Defined by UmlExtensions.)
System_CAPS_pubmethod GetDependencyClients()

Return a collection of elements that are dependent on this.(Defined by NamedElementExtensions.)
System_CAPS_pubmethod GetDependencySuppliers()

Return a collection of elements on which this is dependent.(Defined by NamedElementExtensions.)
System_CAPS_pubmethod GetId()

Gets a GUID that identifies this element.(Defined by UmlExtensions.)
System_CAPS_pubmethod GetImportedPackages()

The imported packages of the namespace(Defined by PackageExtensions.)
System_CAPS_pubmethod GetImportingNamespaces()

The importing namespace of the package(Defined by PackageExtensions.)
System_CAPS_pubmethod GetModelStore()

Overloaded. Gets the IModelStore that contains this element.(Defined by UmlExtensions.)
System_CAPS_pubmethod GetReferences(String)

Get the IReferences of a given tag that are associated with this element.(Defined by UmlExtensions.)
System_CAPS_pubmethod GetRelatedElements<T>()

Gets elements related to this element by relationships of the specified type.(Defined by UmlExtensions.)
System_CAPS_pubmethod GetRelatedLinks<T>()

Gets relationships of a specified type from or to this element.(Defined by UmlExtensions.)
System_CAPS_pubmethod Shapes(IDiagram)

Overloaded. All the shapes that display the model element on any open diagram, or on a specified open diagram.(Defined by PresentationHelpers.)

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

Microsoft.VisualStudio.Uml.Classes Namespace

Return to top