Share via


IPort Interface

 

A property that specifies a distinct interaction point between an object and its environment or its internal parts.

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

Syntax

public interface IPort : IProperty, IStructuralFeature, IFeature, 
    IRedefinableElement, INamedElement, IElement, IMultiplicityElement, 
    ITypedElement, ITemplateableElement, IConnectableElement, IParameterableElement, 
    IDeploymentTarget
public interface class IPort : IProperty, IStructuralFeature, 
    IFeature, IRedefinableElement, INamedElement, IElement, IMultiplicityElement, 
    ITypedElement, ITemplateableElement, IConnectableElement, IParameterableElement, 
    IDeploymentTarget
type IPort = 
    interface
        interface IProperty
        interface IStructuralFeature
        interface IFeature
        interface IRedefinableElement
        interface INamedElement
        interface IElement
        interface IMultiplicityElement
        interface ITypedElement
        interface ITemplateableElement
        interface IConnectableElement
        interface IParameterableElement
        interface IDeploymentTarget
    end
Public Interface IPort
    Inherits IProperty, IStructuralFeature, IFeature, IRedefinableElement,
    INamedElement, IElement, IMultiplicityElement, ITypedElement,
    ITemplateableElement, IConnectableElement, IParameterableElement,
    IDeploymentTarget

Properties

Name Description
System_CAPS_pubproperty Aggregation

If Composite, the object in this property forms part of the property's owner. If Aggregate, the object forms part of a collection represented by the owner, but can be shared with other owners. Default = none. (Inherited from IProperty.)

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 Association

If this Property represents one end of an Association, gets the Association. (Inherited from IProperty.)

System_CAPS_pubproperty Class

Gets the Class that owns the Property. Null if the Property is owned by another kind of Classifier such as an Interface. (Inherited from IProperty.)

System_CAPS_pubproperty Classifier

Gets the Classifier that owns this Property. (Inherited from IProperty.)

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 that is evaluated to give a default value for the Property when an object of the owning Classifier is instantiated. (Inherited from IProperty.)

System_CAPS_pubproperty DefaultValue

Gets the specification of the initial value of the property when a new instance of the owning classifier is created. (Inherited from IProperty.)

System_CAPS_pubproperty DeployedElements

Gets elements that have been deployed to this target. (Inherited from IDeploymentTarget.)

System_CAPS_pubproperty Deployments

Gets Deployments that have deployed elements to this target. (Inherited from IDeploymentTarget.)

System_CAPS_pubproperty Description

The description of this element. (Inherited from IElement.)

System_CAPS_pubproperty Ends

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

System_CAPS_pubproperty FeaturingClassifiers

Gets the Classifiers on which this Feature appears. (Inherited from IFeature.)

System_CAPS_pubproperty IsBehavior

True if messages sent to this port will be handled by the owning object itself, instead of its internal parts.

System_CAPS_pubproperty IsComposite

True if this property's Aggregation = Composite. (Inherited from IProperty.)

System_CAPS_pubproperty IsDerived

True if the value of this property is calculated from others. For example: Diagonal, calculated from Width and Height (Inherited from IProperty.)

System_CAPS_pubproperty IsDerivedUnion

True if this Property is a collection that is the union of two or more other Properties. For example, Parents is a derived union of {Mother, Father}. (Inherited from IProperty.)

System_CAPS_pubproperty IsLeaf

True if this element should not be specialized. That is, it should not be the target of a Generalization relationship. (Inherited from IRedefinableElement.)

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 IsReadOnly

True if the value of the property cannot be changed. (Inherited from IStructuralFeature.)

System_CAPS_pubproperty IsService

True if this port forms part of the published external function of the owning object. False if the port is considered part of the implementation.

System_CAPS_pubproperty IsStatic

True if this feature is shared by all the instances of its classifier. False if each instance effectively has a separate copy of the feature. (Inherited from IFeature.)

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 Opposite

If not empty, this Property is one end of an Association, and this gets the Property at the other end. (Inherited from IProperty.)

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 OwningAssociation

If this Property is owned by an Association, gets the Association. (Inherited from IProperty.)

System_CAPS_pubproperty OwningTemplateParameter

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

System_CAPS_pubproperty Provided

Gets Interfaces specifying a set of operations and events that the owning object offers.

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 Required

Gets Interfaces specifying a set of operations and receptions that the owning object requires its environment to handle.

System_CAPS_pubproperty Signature

Gets a string that describes the visibility, name, type, and multiplicity of the property. For example: + employees : Person [*] (Inherited from IProperty.)

System_CAPS_pubproperty TemplateBindings

Gets the Bindings in which this element is used. (Inherited from ITemplateableElement.)

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 Property(Defined by PropertyExtensions.)

System_CAPS_pubmethod CreateLiteralIntegerDefaultValue()

Create a new ILiteralInteger object in the Property(Defined by PropertyExtensions.)

System_CAPS_pubmethod CreateLiteralStringDefaultValue()

Create a new ILiteralString object in the Property(Defined by PropertyExtensions.)

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 SetNavigable(Boolean)

Sets the navigability of this end of an association.(Defined by ClassifierExtensions.)

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.CompositeStructures Namespace

Return to top