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)

System::Object
  Microsoft.VisualStudio.Modeling.Integration::ModelBusReference

public ref class ModelBusReference : IEquatable<ModelBusReference^>

NameDescription
System_CAPS_pubpropertyAdapterReference

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_pubpropertyElementDisplayName

User-friendly model display name

System_CAPS_pubpropertyIsAdapterReferenceResolved

Returns whether the adapter reference has been deserialized or not.

System_CAPS_pubpropertyLastStatus

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_pubpropertyLogicalAdapterId

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

System_CAPS_pubpropertyModelBus

System_CAPS_pubpropertyModelDisplayName

User-friendly model display name

System_CAPS_pubpropertyReferenceContext

ReferenceContext object for this reference

System_CAPS_pubpropertySerializedAdapterReference

Serialized form of the adapter reference

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticDeserialize(String^, IModelBus^, ReferenceContext^)

Deserializes the serializedReference and returns a new instance of ModelBusReference

System_CAPS_pubmethodSystem_CAPS_staticDeserialize(String^, ReferenceContext^)

Deserializes the serializedReference and returns a new instance of ModelBusReference

System_CAPS_pubmethodEquals(ModelBusReference^)

Overrides equality for ModelBusReferences

System_CAPS_pubmethodEquals(Object^)

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

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

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_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticSerialize(ModelBusReference^)

Returns the supplied reference serialized as a string

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticEquality(ModelBusReference^, ModelBusReference^)

Compares two ModelBusReference instances for equality.

System_CAPS_puboperatorSystem_CAPS_staticInequality(ModelBusReference^, ModelBusReference^)

Compares two ModelBusReferences instances for inequality.

NameDescription
System_CAPS_pubmethodGetDisplayName()

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

System_CAPS_pubmethodIsValidModelReference()

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

System_CAPS_pubmethodIsValidReference()

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.

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

Return to top
Show: