ModelBusReference Class


Encapsulates a reference to a model. The following variants are supported: reference to a model; reference to an element in a model; reference to a model and a view of that model; reference to an element in a model with a view.

Namespace:   Microsoft.VisualStudio.Modeling.Integration
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Integration.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Integration.12.0.dll)

Inheritance Hierarchy



public class ModelBusReference : IEquatable<ModelBusReference>
public ref class ModelBusReference : IEquatable<ModelBusReference^>
type ModelBusReference = 
        interface IEquatable<ModelBusReference>
Public Class ModelBusReference
    Implements IEquatable(Of ModelBusReference)


Name Description
System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, ModelBusAdapterReference)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, ModelBusAdapterReference, ReferenceContext)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, String)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, String, ModelBusAdapterReference)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, String, ModelBusAdapterReference, ReferenceContext)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, String, ReferenceContext)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, String, String)


System_CAPS_pubmethod ModelBusReference(IModelBus, String, String, String, String, ReferenceContext)


System_CAPS_pubmethod ModelBusReference(String, String, String)


System_CAPS_pubmethod ModelBusReference(String, String, String, ReferenceContext)


System_CAPS_pubmethod ModelBusReference(String, String, String, String)


System_CAPS_pubmethod ModelBusReference(String, String, String, String, ReferenceContext)



Name Description
System_CAPS_pubproperty AdapterReference

Returns the adapter reference contained in the model bus reference, or null if the adapter manager required to deserialize the adapter reference is not registered with the modelbus, or if this model bus reference does not have a ModelBus.

System_CAPS_pubproperty ElementDisplayName

User-friendly model display name

System_CAPS_pubproperty IsAdapterReferenceResolved

Returns whether the adapter reference has been deserialized or not.

System_CAPS_pubproperty LastStatus

The last know reference status. The reference status is unknown until we tried to create an adpapter for the reference - in case of success the state will be valid, other wise invalid

System_CAPS_pubproperty LogicalAdapterId

Logical Adapter Id of the ModelBusAdapter that enables access to the model, element or view referenced by this ModelBus Reference.

System_CAPS_pubproperty ModelBus

System_CAPS_pubproperty ModelDisplayName

User-friendly model display name

System_CAPS_pubproperty ReferenceContext

ReferenceContext object for this reference

System_CAPS_pubproperty SerializedAdapterReference

Serialized form of the adapter reference


Name Description
System_CAPS_pubmethodSystem_CAPS_static Deserialize(String, IModelBus, ReferenceContext)

Deserializes the serializedReference and returns a new instance of ModelBusReference

System_CAPS_pubmethodSystem_CAPS_static Deserialize(String, ReferenceContext)

Deserializes the serializedReference and returns a new instance of ModelBusReference

System_CAPS_pubmethod Equals(ModelBusReference)

Overrides equality for ModelBusReferences

System_CAPS_pubmethod Equals(Object)

Compares this reference to another object.(Overrides Object.Equals(Object).)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

Gets the hash code of this reference instance. If two instances compare equal, they should give the same hash code.(Overrides Object.GetHashCode().)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_static Serialize(ModelBusReference)

Returns the supplied reference serialized as a string

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Name Description
System_CAPS_puboperatorSystem_CAPS_static Equality(ModelBusReference, ModelBusReference)

Compares two ModelBusReference instances for equality.

System_CAPS_puboperatorSystem_CAPS_static Inequality(ModelBusReference, ModelBusReference)

Compares two ModelBusReferences instances for inequality.

Extension Methods

Name Description
System_CAPS_pubmethod GetDisplayName()

Extension method that returns the calculated display name(Defined by ModelBusReferenceExtensionMethods.)

System_CAPS_pubmethod IsValidModelReference()

Extension method that returns whether the model-part of the reference is valid(Defined by ModelBusReferenceExtensionMethods.)

System_CAPS_pubmethod IsValidReference()

Extension method that returns whether the whole reference is valid(Defined by ModelBusReferenceExtensionMethods.)


The exact interpretation of a ModelBusReference depends on the derived class of ModelBusAdapter that you use to wrap the model.

For more information, see Integrating Models by using Visual Studio Modelbus.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.VisualStudio.Modeling.Integration Namespace

Return to top