IComponent Interface

A modular part of a system with explicitly defined required and provided interfaces.

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

Syntax

'Declaration
Public Interface IComponent _
    Inherits IClass, IBehavioredClassifier, IEncapsulatedClassifier, IStructuredClassifier,  _
    IClassifier, IType, IPackageableElement, IParameterableElement, INamespace,  _
    IRedefinableElement, INamedElement, ITemplateableElement, IElement

public interface IComponent : IClass, 
    IBehavioredClassifier, IEncapsulatedClassifier, IStructuredClassifier, IClassifier, IType, 
    IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, INamedElement, 
    ITemplateableElement, IElement

public interface class IComponent : IClass, 
    IBehavioredClassifier, IEncapsulatedClassifier, IStructuredClassifier, IClassifier, IType, 
    IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, INamedElement, 
    ITemplateableElement, IElement

type IComponent =  
    interface 
        interface IClass 
        interface IBehavioredClassifier 
        interface IEncapsulatedClassifier 
        interface IStructuredClassifier 
        interface IClassifier 
        interface IType 
        interface IPackageableElement 
        interface IParameterableElement 
        interface INamespace 
        interface IRedefinableElement 
        interface INamedElement 
        interface ITemplateableElement 
        interface IElement 
    end

public interface IComponent extends IClass, IBehavioredClassifier, IEncapsulatedClassifier, IStructuredClassifier, IClassifier, IType, IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, INamedElement, ITemplateableElement, IElement

The IComponent type exposes the following members.

Properties

	Name	Description
	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.)
	Features	Gets the Attributes, Operations and Receptions that are associated with every member of this class. A subset of Namespace::Member. (Inherited from IClassifier.)
	Generalizations	Gets the Generalization relationships through which this Classifier inherits Features. (Inherited from IClassifier.)
	Generals	Gets the Classifiers from which this Classifier inherits Members. (Inherited from IClassifier.)
	InheritedMembers	Gets the subset of Members that are inherited. (Inherited from IClassifier.)
	InterfaceRealizations	Gets the Interfaces realized by this behavior. (Inherited from IBehavioredClassifier.)
	IsAbstract	True if this is a partial description intended to be extended or overridden in specializing classes. (Inherited from IClassifier.)
	IsActiveClass	True if each instance of this class is associated with a thread of control. (Inherited from IClass.)
	IsIndirectlyInstantiated	True if the component is a design-time artifact that does not correspond directly to a single run-time class. Default = true.
	IsLeaf	True if this element should not be specialized. That is, it should not be the target of a Generalization relationship. (Inherited from IRedefinableElement.)
	IsTemplate	True if this class is a template that can be bound to parameters. (Inherited from IClassifier.)
	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.)
	NestedClassifiers	Gets the list of classes that are defined inside this class. (Inherited from IClass.)
	OwnedAttributes	Gets the list of attributes (properties) that are defined in this class. (Inherited from IClass.)
	OwnedBehaviors	Gets the Behaviors defined within the scope of this classifier. (Inherited from IBehavioredClassifier.)
	OwnedComments	Gets Comments contained in this element (not comments linked to it). (Inherited from IElement.)
	OwnedConnectors	Gets the connectors owned by the classifier, for example the Assembly and Delegate connectors in a Component. (Inherited from IStructuredClassifier.)
	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.)
	OwnedOperations	Gets the list of operations that are defined in this class. (Inherited from IClass.)
	OwnedPorts	Gets the Ports through which instances of this type interact with other instances. (Inherited from IEncapsulatedClassifier.)
	OwnedRedefinableTemplateSignature	(Inherited from IClassifier.)
	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.)
	Package	Gets the package to which the type belongs. (Inherited from IType.)
	PackageImports	Gets the packages that are imported by this namespace. (Inherited from INamespace.)
	Parts	Gets the Properties of which this classifier is composed. (Inherited from IStructuredClassifier.)
	Provided	Gets the Interfaces that define messages that the component implements and that other components can use.
	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.)
	Required	Gets the Interfaces that define messages that the component sends to other components or systems.
	SuperClasses	Gets the Classes from which this class inherits features. (Inherited from IClass.)
	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.)
	TypedElements	Gets the Typed elements that are constrained to contain values of this type. (Inherited from IType.)
	UseCases	Gets the Use Cases for which this Classifier is the Subject. (Inherited from IClassifier.)
	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.)
	CreateAttribute	Create a new IProperty object in the Class (Defined by ClassExtensions.)
	CreateConnector	Connect the source element to a target element, such as a Part or Port. If the source or target is a Port located on a Part, specify both. (Defined by ConnectableElementExtensions.)
	CreateGeneralization	Create a new generalization of this classifier. An IGeneralization relationship is created between this and another given classifier. (Defined by ClassifierExtensions.)
	CreateInteraction	Create a new IInteraction object in the BehavioredClassifier (Defined by BehavioredClassifierExtensions.)
	CreateNestedActivity	Create an activity that describes the behavior of this element. (Defined by BehavioredClassifierExtensions.)
	CreateOperation	Create a new IOperation object in the Class (Defined by ClassExtensions.)
	CreatePackageImport	Import a package into a namespace. Creates an IPackageImport link to the package. (Defined by NamespaceExtensions.)
	CreatePart()	Overloaded. Create a new Part, with an unspecified type. (Defined by StructuredClassifierExtensions.)
	CreatePart(IComponent)	Overloaded. Create a new Part, with a given type, or with a new type. Specify a null type to create a new Component as the type of the Part. (Defined by StructuredClassifierExtensions.)
	CreatePortWithProvidedInterface()	Overloaded. Create a new Provided Interface port object in the component. A new interface is also created within the same package as the component. (Defined by ComponentExtensions.)
	CreatePortWithProvidedInterface(IInterface)	Overloaded. Create a new Provided Interface port whose type is an existing Interface. (Defined by ComponentExtensions.)
	CreatePortWithRequiredInterface()	Overloaded. Create a new Required Interface port object in the IComponent. A new interface is also created within the same package as the component. (Defined by ComponentExtensions.)
	CreatePortWithRequiredInterface(IInterface)	Overloaded. Create a new Required Interface port whose type is an existing Interface. (Defined by ComponentExtensions.)
	CreateTemplateBinding	Bind the given classifier to given template classifier. If required, add parameter substitutions using CreateSubstitution. (Defined by TemplateBindingExtensions.)
	CreateTemplateParameter(IParameterableElement)	Overloaded. Creates a template parameter that references given parameteredElement. (Defined by TemplateBindingExtensions.)
	CreateTemplateParameter(TemplateParameterKind, String)	Overloaded. Creates a template parameter with the given name. (Defined by TemplateBindingExtensions.)
	CreateTemplateSignature	Creates a template signature on the given classifier. (Defined by TemplateBindingExtensions.)
	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.)
	FindTemplateParameter	Find a template parameter by name. (Defined by TemplateBindingExtensions.)
	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.)
	GetModelStore	Gets the IModelStore that contains this element. (Defined by UmlExtensions.)
	GetOutgoingAssociationEnds	The opposite ends of the associations that are linked to this classifier. From the association ends, you can get the linked classifier and its type. (Defined by ClassifierExtensions.)
	GetRealizedInterfaces	Returns a collection of the IInterfaces implemented by the given classifier. (Defined by BehavioredClassifierExtensions.)
	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.)
	GetSpecifics	Returns all the classifiers that specialize this classifier. (Defined by ClassifierExtensions.)
	SetOwner(IPackage)	Overloaded. Change the owner. (Defined by SetOwnerExtensions.)
	SetOwner(IPackage)	Overloaded. Change the owner. (Defined by SetOwnerExtensions.)
	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.Components Namespace