Share via


Microsoft.VisualStudio.Modeling.Integration Namespace

 

The types in this namespace help you to define tools that work with more than one DSL model. ModelBus provides a mechanism for defining a reference to an element in a model file. This can be used, for example, to make links from one file to another. For more information, see Integrating Models by using Visual Studio Modelbus.

Classes

Class Description
System_CAPS_pubclass AdapterAlreadyRegisteredException

This defines the AdapterAlreadyRegisteredException class, which is thrown to signal duplicate registration of the same IAdapter instance.

System_CAPS_pubclass AdapterCreationException

This defines the AdapterCreationException class, which is thrown when a call to CreateAdapter() fails.

System_CAPS_pubclass AdapterManagerAlreadyRegisteredException

This defines the AdapterManagerAlreadyRegisteredException class, which is thrown to signal duplicate registration of the same IAdapterManager type.

System_CAPS_pubclass AdapterManagerNotRegisteredException

This file defines the AdapterManagerNotRegisteredException class, which is thrown when a ModelBusAdapter manager is requested but is not registered.

System_CAPS_pubclass AdapterNotRegisteredException

This defines the AdapterNotRegisteredException class, which is thrown when a ModelBusAdapter is requested but is not registered.

System_CAPS_pubclass AdapterNotSupportedException

Exception type thrown when an adapter manager is asked to handle a type of adapter that it does not support.

System_CAPS_pubclass AdapterReferenceTypeNotSupportedException

Exception type thrown when an adapter manager is asked to serialized type of ModelBusAdapterReference that it does not support.

System_CAPS_pubclass CompositionAttributes

System_CAPS_pubclass CompositionConfigurationManager

Class to provide a MEF-based way of configuring the ModelBus

System_CAPS_pubclass DynamicAdapterManagerAttribute

Custom attribute used to indicate that an adapter manager supports any arbitrary LogicalAdapterId. Using this attribute on an AdapterManager implies that the AdapterManager can be used generically to support multiple different Adapters or multiple different Models. The MEF based ModelBus ConfigurationManager will query such AdapterManagers to discover which AdapterIds they support at runtime rather than just rely on MEF meta-data thus allowing the AdapterManager to dynamically support arbitrary models.

System_CAPS_pubclass HandlesAdapterAttribute

Custom attribute used to indicate that an adapter manager handles a particular type of adapter

System_CAPS_pubclass HostSpecificAttribute

Custom attribute used to indicate that a ModelBus part works in a particular ModelBus host.

System_CAPS_pubclass InvalidAdapterManagerException

Exception class for invalid adapter manager exceptions

System_CAPS_pubclass ModelBus

ModelBus allows tools to interoperate in a loosely coupled fashion.

System_CAPS_pubclass ModelBusAdapter

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.

System_CAPS_pubclass ModelBusAdapterManager

The ModelBusAdapterManager is used to create instances of the supported ModelBusAdapter, and manage their lifetime. Derive from this class to create a ModelBusAdapterManager for your own DSL.

System_CAPS_pubclass ModelBusAdapterReference

Base class for all adapter references

System_CAPS_pubclass ModelBusException

This defines the ModelBusException class, which is the base of all exceptions used by ModelBus architecture.

System_CAPS_pubclass ModelBusReference

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.

System_CAPS_pubclass ModelBusReferenceFormatException

System_CAPS_pubclass ModelBusReferencePropertySerializer

Custom DomainProperty serializer to serialize/deserializer ModelBusReferences

System_CAPS_pubclass ModelBusReferenceTypeConverter

Converter that can convert ModelBusReferences to strings.

System_CAPS_pubclass ModelBusResetException

This defines the ModelBusResetException class, which is thrown when Backplane.Reset() fails.

System_CAPS_pubclass ModelBusView

ModelBusView is an object obtained from a ModelBusAdapter for a Model. The ModelBusView allows the client to create, access and manipulate the design surface or editor for the model.

System_CAPS_pubclass ModelingAdapter

Wraps a domain-specific language model. Derive from this class to create an adapter for your DSL.

System_CAPS_pubclass ModelingAdapterReference

Standard DSL implementation of an adapter reference.

System_CAPS_pubclass ModelingAdapterReferenceFormatException

System_CAPS_pubclass ModelingDocumentHandler

This is a pluggable class that a ModelBusAdapter can use for configuring management of the underlying Document represented by this ModelBusAdapter.

System_CAPS_pubclass PresentationAlreadyCreatedException

This defines the PresentationAlreadyCreatedException class, which is thrown when a call to CreatePresentation() is made on a service that already has a presentation of the given type.

System_CAPS_pubclass PresentationCreationException

This defines the PresentationCreationException class, which is thrown when a call to CreatePresentation() fails.

System_CAPS_pubclass ReferenceContext

When a ModelBusReference is serialized, the serialized string can be made relative to some context information such as a file path. When the string is deserialized, you can provide the same context or a different context. ReferenceContext is a dictionary that stores the context information. The set of keys and types stored in a context depend on the class of ModelBusAdapter that you use.

System_CAPS_pubclass ReferenceFormatException

This defines the ReferenceFormatException class, which is thrown when a reference does not conform to the correct format.

System_CAPS_pubclass StandardModelingAdapter

Represents a basic DSL based model adapter.

System_CAPS_pubclass SupportedType

Class the holds the adapter manager's supported type and it's display name

System_CAPS_pubclass ViewOperationException

This defines the ViewOperationException class, which is thrown when an creation of ModelBusView or an operation on a ModelBusView instance fails.

Interfaces

Interface Description
System_CAPS_pubinterface IConfiguration

System_CAPS_pubinterface IModelBus

Obtain an instance of this type from a service provider and use it to obtain an adapter that can be used to open another model.

System_CAPS_pubinterface IModelingAdapterWithRootedModel

Interface implemented by ModelBus adapters that expose the root element of the model.

System_CAPS_pubinterface IModelingAdapterWithStore

Interface implemented by ModelBus adapters that expose the store.

System_CAPS_pubinterface SModelBus

The service interface for the Visual Studio ModelBus service.

Enumerations

Enumeration Description
System_CAPS_pubenum ErrorCategory

Enumeration to specify the severity of an error

System_CAPS_pubenum ReferenceStatus

System_CAPS_pubenum ValidateReferenceOption

Validation options

Return to top