Share via


ModelBusAdapter Class

 

A ModelBusAdapter is an object that serves as a bridge between the ModelBus and the underlying model. ModelBusAdapter instances are created by ModelBusAdapterManager, and the operations a ModelBusAdapter exposes are defined by the ModelBusAdapter contract of the ModelBusAdapterManager.

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.ModelBusAdapter
    Microsoft.VisualStudio.Modeling.Integration.ModelingAdapter

Syntax

public abstract class ModelBusAdapter : IEquatable<ModelBusAdapter>, 
    IDisposable
public ref class ModelBusAdapter abstract : IEquatable<ModelBusAdapter^>, 
    IDisposable
[<AbstractClass>]
type ModelBusAdapter = 
    class
        interface IEquatable<ModelBusAdapter>
        interface IDisposable
    end
Public MustInherit Class ModelBusAdapter
    Implements IEquatable(Of ModelBusAdapter), IDisposable

Constructors

Name Description
System_CAPS_protmethod ModelBusAdapter(ModelBusReference, ModelBusAdapterManager)

Constructor

Properties

Name Description
System_CAPS_pubproperty AdapterManager

ModelBusAdapterManager instance that creates this ModelBusAdapter instance.

System_CAPS_pubproperty DisplayName

The display name of the ModelBusAdapter

System_CAPS_pubproperty Disposed

True if this ModelBusAdapter instance has been disposed, false otherwise.

System_CAPS_pubproperty Reference

Methods

Name Description
System_CAPS_pubmethod Dispose()

System_CAPS_protmethod Dispose(Boolean)

Dispose this ModelBusAdapter instance. The base class does nothing. Derived ModelBusAdapter implementations can choose to do additional work, including persist unsaved data, free up resources, etc.

System_CAPS_pubmethod Equals(ModelBusAdapter)

True if this ModelBusAdapter is the same as the given ModelBusAdapter instance, false otherwise.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

Destructor.(Overrides Object.Finalize().)

System_CAPS_pubmethod GetDefaultView()

Obtains the DefaultView associated with this Model, if one is available.

System_CAPS_pubmethod GetElementReference(Object)

Get the reference of a given object instance supposed to be exposed by this adapter.

System_CAPS_protmethod GetElementReferences(Type)

Get back all referenced objects that conform to a given data contract.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetReferences(Type)

System_CAPS_protmethod GetReferenceStatus()

Returns the ReferenceStatus for the current reference. If this is an element reference then tries ResolveElementReference.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod GetView(ModelBusReference)

Gets a specific view associated with this Model based on the ModelBusView reference

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ResolveElementReference(ModelBusReference)

Given an identifier for an Element, returns the actual object represented by this reference.

System_CAPS_pubmethod ResolveElementReference<T>(ModelBusReference)

Given an identifier for an Element, returns the actual object represented by this reference (strong typed helper method)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

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