IParameter Interface

Specifies the type of object that can be passed in or out of a behavior.

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

Syntax

'Declaration
Public Interface IParameter _
    Inherits IMultiplicityElement, IConnectableElement, ITypedElement, IParameterableElement,  _
    INamedElement, IElement

public interface IParameter : IMultiplicityElement, 
    IConnectableElement, ITypedElement, IParameterableElement, INamedElement, IElement

public interface class IParameter : IMultiplicityElement, 
    IConnectableElement, ITypedElement, IParameterableElement, INamedElement, IElement

type IParameter =  
    interface 
        interface IMultiplicityElement 
        interface IConnectableElement 
        interface ITypedElement 
        interface IParameterableElement 
        interface INamedElement 
        interface IElement 
    end

public interface IParameter extends IMultiplicityElement, IConnectableElement, ITypedElement, IParameterableElement, INamedElement, IElement

The IParameter 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.)
	Default	Gets a string representing the default value of the parameter when no argument is supplied.
	DefaultValue	A value to be used when no argument is supplied for the Parameter.
	Description	The description of this element. (Inherited from IElement.)
	Direction	In = data is passed into the behavior; out = data is passed out; inout = data is passed in and then out; return = data is passed back to the caller as a return value at the end of execution.
	Ends	Gets the connector ends to which this element is connected. (Inherited from IConnectableElement.)
	IsOrdered	For multiplicity > 1. True if the elements in the collection form a sequence with a definite order. (Inherited from IMultiplicityElement.)
	IsUnique	For multiplicity > 1. True if each value in the collection is different from the other values. Default = True. (Inherited from IMultiplicityElement.)
	LowerValue	Gets the minimum number of elements allowed. Must be at least 0, and must not be *. (Inherited from IMultiplicityElement.)
	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.)
	Operation	Gets the operation that owns the parameter.
	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.)
	OwningTemplateParameter	If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
	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.)
	TemplateParameter	If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
	Type	The type of instance that can be assigned to the element. If not specified, any instance can be assigned. (Inherited from ITypedElement.)
	UpperValue	Gets the maximum number of elements allowed. If *, there is no maximum. Must be at least 1. (Inherited from IMultiplicityElement.)
	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.)
	CreateLiteralBooleanDefaultValue	Create a new ILiteralBoolean object in the Parameter (Defined by ParameterExtensions.)
	CreateLiteralIntegerDefaultValue	Create a new ILiteralInteger object in the Parameter (Defined by ParameterExtensions.)
	CreateLiteralStringDefaultValue	Create a new ILiteralString object in the Parameter (Defined by ParameterExtensions.)
	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.)
	GetBounds	The multiplicity as a string in the form [LowerValue]..[UpperValue]. (Defined by MultiplicityElementExtensions.)
	GetConnectedElements	The elements connected to this element using Connectors. For example, if this element is a Part in a Component, this method returns the Parts and Ports that are connected to it. (Defined by ConnectableElementExtensions.)
	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.)
	SetBounds	Set the multiplicity LowerValue/UpperValue based on a string in the form [LowerValue]..[UpperValue]. [UpperValue] may be '*'. (Defined by MultiplicityElementExtensions.)
	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