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

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

Syntax

public class ModelBusReference : IEquatable<ModelBusReference>

public ref class ModelBusReference : IEquatable<ModelBusReference^>

type ModelBusReference = 
    class
        interface IEquatable<ModelBusReference>
    end

Public Class ModelBusReference
    Implements IEquatable(Of ModelBusReference)

Constructors

	Name	Description
	ModelBusReference(IModelBus, String, String, ModelBusAdapterReference)	Constructor
	ModelBusReference(IModelBus, String, String, ModelBusAdapterReference, ReferenceContext)	Constructor
	ModelBusReference(IModelBus, String, String, String)	Constructor
	ModelBusReference(IModelBus, String, String, String, ModelBusAdapterReference)	Constructor
	ModelBusReference(IModelBus, String, String, String, ModelBusAdapterReference, ReferenceContext)	Constructor
	ModelBusReference(IModelBus, String, String, String, ReferenceContext)	Constructor
	ModelBusReference(IModelBus, String, String, String, String)	Constructor
	ModelBusReference(IModelBus, String, String, String, String, ReferenceContext)	Constructor
	ModelBusReference(String, String, String)	Constructor
	ModelBusReference(String, String, String, ReferenceContext)	Constructor
	ModelBusReference(String, String, String, String)	Constructor
	ModelBusReference(String, String, String, String, ReferenceContext)	Constructor

Properties

	Name	Description
	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.
	ElementDisplayName	User-friendly model display name
	IsAdapterReferenceResolved	Returns whether the adapter reference has been deserialized or not.
	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
	LogicalAdapterId	Logical Adapter Id of the ModelBusAdapter that enables access to the model, element or view referenced by this ModelBus Reference.
	ModelBus
	ModelDisplayName	User-friendly model display name
	ReferenceContext	ReferenceContext object for this reference
	SerializedAdapterReference	Serialized form of the adapter reference

Methods

	Name	Description
	Deserialize(String, IModelBus, ReferenceContext)	Deserializes the serializedReference and returns a new instance of ModelBusReference
	Deserialize(String, ReferenceContext)	Deserializes the serializedReference and returns a new instance of ModelBusReference
	Equals(ModelBusReference)	Overrides equality for ModelBusReferences
	Equals(Object)	Compares this reference to another object.(Overrides Object.Equals(Object).)
	Finalize()	(Inherited from Object.)
	GetHashCode()	Gets the hash code of this reference instance. If two instances compare equal, they should give the same hash code.(Overrides Object.GetHashCode().)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	Serialize(ModelBusReference)	Returns the supplied reference serialized as a string
	ToString()	(Inherited from Object.)

Operators

	Name	Description
	Equality(ModelBusReference, ModelBusReference)	Compares two ModelBusReference instances for equality.
	Inequality(ModelBusReference, ModelBusReference)	Compares two ModelBusReferences instances for inequality.

Extension Methods

	Name	Description
	GetDisplayName()	Extension method that returns the calculated display name(Defined by ModelBusReferenceExtensionMethods.)
	IsValidModelReference()	Extension method that returns whether the model-part of the reference is valid(Defined by ModelBusReferenceExtensionMethods.)
	IsValidReference()	Extension method that returns whether the whole reference is valid(Defined by ModelBusReferenceExtensionMethods.)

Remarks

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