Microsoft.VisualStudio.Modeling.Integration Namespace

  • Article

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
Public class AdapterAlreadyRegisteredException This defines the AdapterAlreadyRegisteredException class, which is thrown to signal duplicate registration of the same IAdapter instance.
Public class AdapterCreationException This defines the AdapterCreationException class, which is thrown when a call to CreateAdapter() fails.
Public class AdapterManagerAlreadyRegisteredException This defines the AdapterManagerAlreadyRegisteredException class, which is thrown to signal duplicate registration of the same IAdapterManager type.
Public class AdapterManagerNotRegisteredException This file defines the AdapterManagerNotRegisteredException class, which is thrown when a ModelBusAdapter manager is requested but is not registered.
Public class AdapterNotRegisteredException This defines the AdapterNotRegisteredException class, which is thrown when a ModelBusAdapter is requested but is not registered.
Public class AdapterNotSupportedException Exception type thrown when an adapter manager is asked to handle a type of adapter that it does not support.
Public class AdapterReferenceTypeNotSupportedException Exception type thrown when an adapter manager is asked to serialized type of ModelBusAdapterReference that it does not support.
Public class CompositionAttributes
Public class CompositionConfigurationManager Class to provide a MEF-based way of configuring the ModelBus
Public class 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.
Public class HandlesAdapterAttribute Custom attribute used to indicate that an adapter manager handles a particular type of adapter
Public class HostSpecificAttribute Custom attribute used to indicate that a ModelBus part works in a particular ModelBus host.
Public class InvalidAdapterManagerException Exception class for invalid adapter manager exceptions
Public class ModelBus ModelBus allows tools to interoperate in a loosely coupled fashion.
Public class 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.
Public class 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.
Public class ModelBusAdapterReference Base class for all adapter references
Public class ModelBusException This defines the ModelBusException class, which is the base of all exceptions used by ModelBus architecture.
Public class 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.
Public class ModelBusReferenceFormatException
Public class ModelBusReferencePropertySerializer Custom DomainProperty serializer to serialize/deserializer ModelBusReferences
Public class ModelBusReferenceTypeConverter Converter that can convert ModelBusReferences to strings.
Public class ModelBusResetException This defines the ModelBusResetException class, which is thrown when Backplane.Reset() fails.
Public class 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.
Public class ModelingAdapter Wraps a domain-specific language model. Derive from this class to create an adapter for your DSL.
Public class ModelingAdapterReference Standard DSL implementation of an adapter reference.
Public class ModelingAdapterReferenceFormatException
Public class ModelingDocumentHandler This is a pluggable class that a ModelBusAdapter can use for configuring management of the underlying Document represented by this ModelBusAdapter.
Public class 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.
Public class PresentationCreationException This defines the PresentationCreationException class, which is thrown when a call to CreatePresentation() fails.
Public class 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.
Public class ReferenceFormatException This defines the ReferenceFormatException class, which is thrown when a reference does not conform to the correct format.
Public class StandardModelingAdapter Represents a basic DSL based model adapter.
Public class SupportedType Class the holds the adapter manager's supported type and it's display name
Public class 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
Public interface IConfiguration
Public interface 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.
Public interface IModelingAdapterWithRootedModel Interface implemented by ModelBus adapters that expose the root element of the model.
Public interface IModelingAdapterWithStore Interface implemented by ModelBus adapters that expose the store.
Public interface SModelBus The service interface for the Visual Studio ModelBus service.

Enumerations

  Enumeration Description
Public enumeration ErrorCategory Enumeration to specify the severity of an error
Public enumeration ReferenceStatus
Public enumeration ValidateReferenceOption Validation options