ModelingAdapter Class
Wraps a domain-specific language model. Derive from this class to create an adapter for your DSL.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.Integration.ModelBusAdapter
Microsoft.VisualStudio.Modeling.Integration.ModelingAdapter
Microsoft.VisualStudio.Modeling.Integration.StandardModelingAdapter
Namespace: Microsoft.VisualStudio.Modeling.Integration
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Integration.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Integration.12.0.dll)
Syntax
'Declaration
Public MustInherit Class ModelingAdapter _
Inherits ModelBusAdapter
public abstract class ModelingAdapter : ModelBusAdapter
public ref class ModelingAdapter abstract : public ModelBusAdapter
[<AbstractClass>]
type ModelingAdapter =
class
inherit ModelBusAdapter
end
public abstract class ModelingAdapter extends ModelBusAdapter
The ModelingAdapter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
ModelingAdapter(ModelBusReference, ModelBusAdapterManager) | Constructor |
|
ModelingAdapter(ModelBusReference, ModelBusAdapterManager, ModelingDocumentHandler) | Constructor |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AdapterManager | ModelBusAdapterManager instance that creates this ModelBusAdapter instance. (Inherited from ModelBusAdapter.) |
|
DisplayName | The display name of the ModelBusAdapter (Inherited from ModelBusAdapter.) |
|
Disposed | True if this ModelBusAdapter instance has been disposed, false otherwise. (Inherited from ModelBusAdapter.) |
|
DocumentHandler | ModelingDocumentHandler used by this ModelingAdapter. The DocumentHandler is used by the ModelBusAdapter to configure the model wrapped by it. You can set this property only if it has not been set already. |
|
Reference | (Inherited from ModelBusAdapter.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dispose() | (Inherited from ModelBusAdapter.) |
|
Dispose(Boolean) | Clean-up this ModelBusAdapter instance. Triggers a dispose of the DocumentHandler, if it has one. (Overrides ModelBusAdapter.Dispose(Boolean).) |
|
Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Equals(ModelBusAdapter) | True if this ModelBusAdapter is the same as the given ModelBusAdapter instance, false otherwise. (Inherited from ModelBusAdapter.) |
|
Finalize | Destructor. (Inherited from ModelBusAdapter.) |
|
GetDefaultView | Obtains the DefaultView associated with this Model, if one is available. (Inherited from ModelBusAdapter.) |
|
GetElementReference | Get the reference of a given object instance supposed to be exposed by this adapter. (Inherited from ModelBusAdapter.) |
|
GetElementReferences | Get back all referenced objects that conform to a given data contract. (Inherited from ModelBusAdapter.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetReferences | (Inherited from ModelBusAdapter.) |
|
GetReferenceStatus | Returns the ReferenceStatus for the current reference. If this is an element reference then tries ResolveElementReference. (Inherited from ModelBusAdapter.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetView | Gets a specific view associated with this Model based on the ModelBusView reference (Inherited from ModelBusAdapter.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ResolveElementReference(ModelBusReference) | Given an identifier for an Element, returns the actual object represented by this reference. (Inherited from ModelBusAdapter.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TrySetDocumentHandler | If the ModelingDocumentHandler is not already set (by the constructor for e.g.), then sets it to the value passed as a parameter. Otherwise, returns false. |
Top
Remarks
Create an adapter on a specified model using an instance of IModelBus.
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.