IArtifact Interface

A reference to a diagram or to a specification document related to the model.

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

Syntax

'Declaration
Public Interface IArtifact _
    Inherits IClassifier, IType, IPackageableElement, IParameterableElement,  _
    INamespace, IRedefinableElement, ITemplateableElement, IDeployedArtifact, INamedElement,  _
    IElement

public interface IArtifact : IClassifier, 
    IType, IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, 
    ITemplateableElement, IDeployedArtifact, INamedElement, IElement

public interface class IArtifact : IClassifier, 
    IType, IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, 
    ITemplateableElement, IDeployedArtifact, INamedElement, IElement

type IArtifact =  
    interface 
        interface IClassifier 
        interface IType 
        interface IPackageableElement 
        interface IParameterableElement 
        interface INamespace 
        interface IRedefinableElement 
        interface ITemplateableElement 
        interface IDeployedArtifact 
        interface INamedElement 
        interface IElement 
    end

public interface IArtifact extends IClassifier, IType, IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, ITemplateableElement, IDeployedArtifact, INamedElement, IElement

The IArtifact 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.)
	FileName	The location where the file is stored.
	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.)
	IsAbstract	True if this is a partial description intended to be extended or overridden in specializing classes. (Inherited from IClassifier.)
	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.)
	Manifestations	Gets model Elements that are carried by the artifact, or used in its construction or generation.
	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.)
	NestedArtifacts	Gets Artifacts that are defined within this Artifact.
	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.)
	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.)
	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.)
	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.)
	CreateGeneralization	Create a new generalization of this classifier. An IGeneralization relationship is created between this and another given classifier. (Defined by ClassifierExtensions.)
	CreateNestedArtifact	Create a new IArtifact object owned by this IArtifact (Defined by ArtifactExtensions.)
	CreatePackageImport	Import a package into a namespace. Creates an IPackageImport link to the package. (Defined by NamespaceExtensions.)
	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.)
	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.)
	Shapes	All the shapes that display the model element on any open diagram, or on a specified open diagram. (Defined by PresentationHelpers.)

Top

Remarks

See Also

Reference

Microsoft.VisualStudio.Uml.Deployments Namespace