IMessage Interface

Article
09/30/2015

A communication between lifelines in an Interaction.

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

Syntax

public interface IMessage : INamedElement, IElement

public interface class IMessage : INamedElement, IElement

type IMessage = 
    interface
        interface INamedElement
        interface IElement
    end

Public Interface IMessage
    Inherits INamedElement, IElement

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.)
	Arguments	Gets the arguments of the Message.
	ClientDependencies	Gets the Dependency relationships for which this element is the Client. (Inherited from INamedElement.)
	Connector	' ~ [0..1] The Connector on which this Message is sent.
	Description	The description of this element. (Inherited from IElement.)
	Interaction	Gets the Interaction in which the Message is defined.
	MessageKind	Lost = the message is sent from a lifeline to an undefined receiver; Found = the message comes from an undefined sender; Complete = the message is sent from one Lifeline to another.
	MessageSort	Synchronous = the sender waits for control to return, and a return arrow is shown on the sequence diagram. Asynchronous = the sender continues after sending the message.
	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.)
	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.)
	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.)
	ReceiveEvent	Gets the Occurrence Specification of the receiving end of the message.
	SendEvent	Gets the Occurrence Specification of the sending end of the message
	Signature	The Operation or Signal of which this Message represents an occurrence. If it is a Signal, the MessageSort must be Asynchronous.
	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.)

Extension Methods

	Name	Description
	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.)
	ApplyStereotype(IStereotype)	Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype.(Defined by ProfileStereotypeExtensions.)
	Delete()	Overloaded. Delete the message.(Defined by InteractionExtensions.)
	DeleteAllReference(String)	Remove all the references of a given tag.(Defined by UmlExtensions.)
	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()	Overloaded. Gets the IModelStore that contains this element.(Defined by UmlExtensions.)
	GetOppositeMessage()	For a synchronous message, returns the reply. For a reply message, returns the outgoing message. Returns null for asynchronous messages.(Defined by MessageExtensions.)
	GetReferences(String)	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.)
	GetSourceExecutionSpecification()	The Execution Specification from which this message is outgoing. Null if this is sourced directly on a lifeline or is a found message.(Defined by MessageExtensions.)
	GetSourceLifeline()	The lifeline from which this message is outgoing. Null if this is a Found message.(Defined by MessageExtensions.)
	GetTargetExecutionSpecification()	The Execution Specification to which this message is incoming. Null if this is targeted directly on a lifeline or is a lost message.(Defined by MessageExtensions.)
	GetTargetLifeline()	The lifeline to which this message is incoming. Null if this is a Lost message.(Defined by MessageExtensions.)
	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

For more information about using this type, see Edit UML sequence diagrams by using the UML API.

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.

IMessage Interface

Syntax

Properties

Extension Methods

Remarks

See Also

Additional resources