Share via

IParameter Interface

  • Article

 

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

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

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

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

Public Interface IParameter
    Inherits ITypedElement, INamedElement, IElement, IMultiplicityElement,
    IConnectableElement, IParameterableElement

Properties

Name Description
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 Default

Gets a string representing the default value of the parameter when no argument is supplied.
System_CAPS_pubproperty DefaultValue

A value to be used when no argument is supplied for the Parameter.
System_CAPS_pubproperty Description

The description of this element. (Inherited from IElement.)
System_CAPS_pubproperty 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.
System_CAPS_pubproperty Ends

Gets the connector ends to which this element is connected. (Inherited from IConnectableElement.)
System_CAPS_pubproperty IsOrdered

For multiplicity > 1. True if the elements in the collection form a sequence with a definite order. (Inherited from IMultiplicityElement.)
System_CAPS_pubproperty IsUnique

For multiplicity > 1. True if each value in the collection is different from the other values. Default = True. (Inherited from IMultiplicityElement.)
System_CAPS_pubproperty LowerValue

Gets the minimum number of elements allowed. Must be at least 0, and must not be *. (Inherited from IMultiplicityElement.)
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 Operation

Gets the operation that owns the parameter.
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 Owner

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

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

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

The type of instance that can be assigned to the element. If not specified, any instance can be assigned. (Inherited from ITypedElement.)
System_CAPS_pubproperty UpperValue

Gets the maximum number of elements allowed. If *, there is no maximum. Must be at least 1. (Inherited from IMultiplicityElement.)
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 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 CreateLiteralBooleanDefaultValue()

Create a new ILiteralBoolean object in the Parameter(Defined by ParameterExtensions.)
System_CAPS_pubmethod CreateLiteralIntegerDefaultValue()

Create a new ILiteralInteger object in the Parameter(Defined by ParameterExtensions.)
System_CAPS_pubmethod CreateLiteralStringDefaultValue()

Create a new ILiteralString object in the Parameter(Defined by ParameterExtensions.)
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 GetBounds()

The multiplicity as a string in the form [LowerValue]..[UpperValue].(Defined by MultiplicityElementExtensions.)
System_CAPS_pubmethod 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.)
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 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 SetBounds(String)

Set the multiplicity LowerValue/UpperValue based on a string in the form [LowerValue]..[UpperValue]. [UpperValue] may be '*'.(Defined by MultiplicityElementExtensions.)
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