Share via


IPin Interface

A parameter or connection on which control and data can flow in or out of an action.

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

Syntax

'Declaration
Public Interface IPin _
    Inherits IObjectNode, IActivityNode, IRedefinableElement, ITypedElement,  _
    INamedElement, IMultiplicityElement, IElement
public interface IPin : IObjectNode, IActivityNode, 
    IRedefinableElement, ITypedElement, INamedElement, IMultiplicityElement, IElement
public interface class IPin : IObjectNode, 
    IActivityNode, IRedefinableElement, ITypedElement, INamedElement, IMultiplicityElement, 
    IElement
type IPin =  
    interface 
        interface IObjectNode 
        interface IActivityNode 
        interface IRedefinableElement 
        interface ITypedElement 
        interface INamedElement 
        interface IMultiplicityElement 
        interface IElement 
    end
public interface IPin extends IObjectNode, IActivityNode, IRedefinableElement, ITypedElement, INamedElement, IMultiplicityElement, IElement

The IPin type exposes the following members.

Properties

  Name Description
Public property Action The action that owns this pin.
Public property Activity Activity that owns the node. (Inherited from IActivityNode.)
Public property ApplicableStereotypes The set of stereotypes that could be applied to this element. (Inherited from IElement.)
Public property AppliedStereotypes Each IStereotypeInstance denotes that a stereotype has been applied to this element. (Inherited from IElement.)
Public property ClientDependencies Gets the Dependency relationships for which this element is the Client. (Inherited from INamedElement.)
Public property Description The description of this element. (Inherited from IElement.)
Public property Incomings Edges that have the node as target. (Inherited from IActivityNode.)
Public property InStates If not empty, this node accepts only objects in the specified states. (Inherited from IObjectNode.)
Public property IsControl True if this Pin is connected to a control flow. False if it is connected to an object flow.
Public property IsControlType True if the node should be connected to control flows rather than data flows. The node can be used to specify that one or more control tokens can be buffered. (Inherited from IObjectNode.)
Public property IsLeaf True if this element should not be specialized. That is, it should not be the target of a Generalization relationship. (Inherited from IRedefinableElement.)
Public property IsOrdered For multiplicity > 1. True if the elements in the collection form a sequence with a definite order. (Inherited from IMultiplicityElement.)
Public property IsUnique For multiplicity > 1. True if each value in the collection is different from the other values. Default = True. (Inherited from IMultiplicityElement.)
Public property LowerValue Gets the minimum number of elements allowed. Must be at least 0, and must not be *. (Inherited from IMultiplicityElement.)
Public property 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.)
Public property Namespace Gets the Namespace in which this element is defined. May be null. (Inherited from INamedElement.)
Public property Ordering Specifies the ordering in which tokens will be processed. For example if FIFO, tokens will be output in the order that they arrive. (Inherited from IObjectNode.)
Public property Outgoings Edges that have the node as source. (Inherited from IActivityNode.)
Public property OwnedComments Gets Comments contained in this element (not comments linked to it). (Inherited from IElement.)
Public property OwnedElements Gets Elements owned by this element. Every element has one owner, except the root IModel. (Inherited from IElement.)
Public property Owner Gets the Element that owns this element. Every element except the root IModel has one owner. (Inherited from IElement.)
Public property 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.)
Public property Selection If defined, this Behavior chooses which object to output next, from the objects buffered in the node. (Inherited from IObjectNode.)
Public property Type The type of instance that can be assigned to the element. If not specified, any instance can be assigned. (Inherited from ITypedElement.)
Public property UpperBound The maximum number of tokens allowed in the node. '*' means there is no limit. Objects cannot flow into the node if the upper bound is reached. (Inherited from IObjectNode.)
Public property UpperValue Gets the maximum number of elements allowed. If *, there is no maximum. Must be at least 1. (Inherited from IMultiplicityElement.)
Public property 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.)
Public property VisibleAppliedStereotypes (Inherited from IElement.)

Top

Extension Methods

  Name Description
Public Extension Method 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.)
Public Extension Method ApplyStereotype Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype. (Defined by ProfileStereotypeExtensions.)
Public Extension Method Delete Deletes this element and any relationships, owned elements, and shapes. (Defined by UmlExtensions.)
Public Extension Method DeleteAllReference Remove all the references of a given tag. (Defined by UmlExtensions.)
Public Extension Method GetActivityEdgeSources The nodes sourcing edges incoming to this one (Defined by ActivityExtensions.)
Public Extension Method GetActivityEdgeTargets The nodes targeted by edges outgoing from this one (Defined by ActivityExtensions.)
Public Extension Method GetBounds The multiplicity as a string in the form [LowerValue]..[UpperValue]. (Defined by MultiplicityElementExtensions.)
Public Extension Method GetDependencyClients Return a collection of elements that are dependent on this. (Defined by NamedElementExtensions.)
Public Extension Method GetDependencySuppliers Return a collection of elements on which this is dependent. (Defined by NamedElementExtensions.)
Public Extension Method GetId Gets a GUID that identifies this element. (Defined by UmlExtensions.)
Public Extension Method GetModelStore Gets the IModelStore that contains this element. (Defined by UmlExtensions.)
Public Extension Method GetReferences Get the IReferences of a given tag that are associated with this element. (Defined by UmlExtensions.)
Public Extension Method GetRelatedElements<T> Gets elements related to this element by relationships of the specified type. (Defined by UmlExtensions.)
Public Extension Method GetRelatedLinks<T> Gets relationships of a specified type from or to this element. (Defined by UmlExtensions.)
Public Extension Method GetUpperBound The upper bound of the current ObjectNode. int.MaxValue is returned if the upper bound is '*'. (Defined by ObjectNodeExtensions.)
Public Extension Method SetBounds Set the multiplicity LowerValue/UpperValue based on a string in the form [LowerValue]..[UpperValue]. [UpperValue] may be '*'. (Defined by MultiplicityElementExtensions.)
Public Extension Method SetUpperBound Set the upper bound. Set the newBound to int.MaxValue to indicate that the upper bound is '*'. (Defined by ObjectNodeExtensions.)
Public Extension Method 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.Actions Namespace