VsModelingAdapterManager Class

  • Article

ModelBusAdapterManager that can handle creation and management of Adapters representing DSL based Model files inside Visual Studio. It provides with ModelBusAdapter life-cycle management and appropriate behavior to support saving changes to underlying referenced models using the VS Shell.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.Integration.ModelBusAdapterManager
    Microsoft.VisualStudio.Modeling.Integration.Shell.VsModelingAdapterManager

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class VsModelingAdapterManager _
    Inherits ModelBusAdapterManager

[CLSCompliantAttribute(false)]
public abstract class VsModelingAdapterManager : ModelBusAdapterManager

[CLSCompliantAttribute(false)]
public ref class VsModelingAdapterManager abstract : public ModelBusAdapterManager

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type VsModelingAdapterManager =  
    class 
        inherit ModelBusAdapterManager 
    end

public abstract class VsModelingAdapterManager extends ModelBusAdapterManager

The VsModelingAdapterManager type exposes the following members.

Constructors

  Name Description
Protected method VsModelingAdapterManager

Top

Properties

  Name Description
Public property Disposed True if this ModelBusAdapterManager instance has been disposed, false otherwise. (Inherited from ModelBusAdapterManager.)
Public property ModelBus Gets the Backplane instance that this ModelBusAdapterManager is registered with. (Inherited from ModelBusAdapterManager.)

Top

Methods

  Name Description
Public method CanCreateReference Can this ModelBusAdapter manager create a scope described by the given contextual information about a model? (Inherited from ModelBusAdapterManager.)
Protected method CheckCanCreateAdapter Checks if an ModelingAdapterReference can be successfully created from this ModelBusReference and also if the LogicalAdapterId is recognized by this ModelBusAdapterManager. This method should throw an appropriate exception if a ModelBusAdapter cannot potentially be created using this ModelBusReference.
Public method CreateAdapter(ModelBusReference) Create a ModelBusAdapter wrapping the specified model. Throws an exception if the ModelBusAdapter cannot be created. (Inherited from ModelBusAdapterManager.)
Public method CreateAdapter(ModelBusReference, IServiceProvider) Create a ModelBusAdapter instance supported by this ModelBusAdapterManager. (Inherited from ModelBusAdapterManager.)
Protected method CreateModelingAdapterInstance Imlementations should provide a ModelingAdapter instance that serves the Model's external world view using the DomainModelRoot element passed.
Public method CreateReference Attempts to create and return a model bus reference from the supplied data. (Inherited from ModelBusAdapterManager.)
Protected method DeserializeAdapterReference (Overrides ModelBusAdapterManager.DeserializeAdapterReference(String, ReferenceContext).)
Public method Dispose() (Inherited from ModelBusAdapterManager.)
Protected method Dispose(Boolean) Dispose this ModelBusAdapterManager instance. (Inherited from ModelBusAdapterManager.)
Protected method DoCreateAdapter Using the ModelBusReference passed as a parameter, creation of a ModelBusAdapter instance is attempted. If successful, the adapter is returned. If not, appropriate exception is thrown. (Overrides ModelBusAdapterManager.DoCreateAdapter(ModelBusReference, IServiceProvider).)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Destructor. (Inherited from ModelBusAdapterManager.)
Public method GetExposedElementTypes Get a collection of all the ModelElement types which are exposed by any ModelBusAdapter managed by this adapter manager, and thus can be referenced from the outside, along with their display name; (Inherited from ModelBusAdapterManager.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetSupportedLogicalAdapterIds Returns the IDs of the adapter types that are supported by this adapter manager (Inherited from ModelBusAdapterManager.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetView Obtains the View associated with the ModelBusAdapter passed as a parameter. (Overrides ModelBusAdapterManager.GetView(ModelBusAdapter, ModelBusReference).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method SerializeAdapterReference (Overrides ModelBusAdapterManager.SerializeAdapterReference(ModelBusAdapterReference, ReferenceContext).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryCreateReference The ModelBusAdapterManager will attempt to create a model bus reference to a model from the supplied information. (Inherited from ModelBusAdapterManager.)
Public method ValidateReference Validates the reference and set the LastStatus accordingly. The default implementation is to create an adapter in order to check if model can be resolved or not. (Inherited from ModelBusAdapterManager.)

Top

Fields

  Name Description
Public fieldStatic member HostName Name used by VisualStudio to identify itself as a ModelBus host.

Top

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

Reference

Microsoft.VisualStudio.Modeling.Integration.Shell Namespace