This documentation is archived and is not being maintained.

Store Class

The store contains an in-memory representation of the elements and links in one or more models.


Namespace:  Microsoft.VisualStudio.Modeling
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.10.0.dll)

public class Store : IServiceProvider, IDisposable

The Store type exposes the following members.

Public methodStore(Type[])Initializes a new instance of the Store class.
Public methodStore(IServiceProvider, Type[])Initializes a new instance of the Store class.
Public methodStore(IServiceProvider, Dictionary<Object, Object>, Type[])Creates an instance of the Store class which delegates IServiceProvider implementation to the given serviceProvider.

Public propertyChangeSourceGets the current change source for operations in the store.
Public propertyCurrentContextGets the current context of the store.
Public propertyDefaultPartitionGets or sets the default partition for the store.
Public propertyDemandLoadingGets whether the store is currently demand loading a relationship.
Public propertyDisposedGets whether the store has been disposed.
Public propertyDomainDataDirectoryGets domain information directory of the store.
Public propertyDomainModelsGets a collection of domain models in this store.
Public propertyElementDirectoryGets the directory of elements contained within the store.
Public propertyElementFactoryGets the element factory for the model.
Public propertyEventManagerDirectoryGets the event manager directory for the model.
Public propertyIdGets the ID of the store.
Public propertyInRedoGets the store and verifies whether the current context of the store is being redone.
Public propertyInSerializationTransactionIndicates that the store has a currently active serialization transaction in the transaction stack
Public propertyInUndoGets the store and verifies whether the current context of the store is being undone.
Public propertyInUndoRedoOrRollbackGets the store and verifies whether the current context of the store is being redone, undone, or rolled back.
Public propertyPartitionsGets the Collection of Partition objects for the store.
Public propertyPartitionsAlternateGets the partitions used in the store.
Public propertyPropertyBagGets the property bag for the store.
Public propertyRuleManagerGets the rule manager for the store.
Public propertySerializerDirectoryThe default serialization directory for this store
Public propertyShuttingDownGets the store and verifies whether the store is shutting down, or sets the state of the store as shutting down.
Public propertyTransactionActiveGets or sets whether the store has a currently active transaction.
Public propertyTransactionLogsGets the current list of transaction logs for the store.
Public propertyTransactionManagerGets the transaction manager for the model.
Public propertyUndoManagerGets the UndoManager for the default context.
Public propertyVersionGets the version of the store.

Public methodAddMonikerResolverRegister an IMonikerResolver for the specified domain model.
Public methodDefaultPartitionForClassReturn the partition into which new elements of the specified class should be created by default.
Public methodDisposeDisposes the store.
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindDomainModelFinds a domain model by its ID.
Public methodFindMonikerResolverFinds the IMonikerResolver registered for the specified domain model.
Public methodGetClosurePrototypeGroup(ICollection<ModelElement>, ClosureType)Creates an element group prototype in the default partition of the given closure type if a list of root elements is specified.
Public methodGetClosurePrototypeGroup(ICollection<ModelElement>, ClosureType, Boolean)Creates an element group prototype in the default partition of the specified closure type when given a list of root elements and allows bypassing of demand loading.
Public methodGetDomainModel(Guid)Gets an instance of a domain model by its ID.
Public methodGetDomainModel<T>()Gets an instance of a specified domain model type.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetServiceGets a service.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLoadDomainModelsCreates all the domain data for the specified list of domain models.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPopContextRemoves the current context off the top of the stack.
Public methodPushContextPushes a new context to the top of the store context stack.
Public methodRegisterTransactionLogAllows a client to register a transaction log that will be notified of events on this store.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUnregisterTransactionLogAllows a client to unregister a transaction log from being notified of events on this store.

Public eventStoreDisposingOccurs when the store is disposing.

Public Extension MethodGetLocksGet the lock flags for this Store instance (Defined by ImmutabilityExtensionMethods.)
Public Extension MethodIsLockedTest whether this store has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
Public Extension MethodSetLocksSet the lock flags of this Store instance (Defined by ImmutabilityExtensionMethods.)

The store contains information about one or more models. A store can contain a collection of models, although often there is only one model in the store.

The store also contains metadata about a model and information about the instances of the elements and links between elements that make up that model. Metadata contains the types allowed in the model and their relationships.

The store has several data structures that are filled when a model is loaded into the store. This occurs under the following circumstances:

  • when your domain-specific language is launched, either as an experimental build

  • when you have deployed your domain-specific language and an end user launches it

  • when you load a model programmatically into the store

The DomainDataDirectory contains the metadata about the types allowed to be in the model.

The ElementDirectory contains information about each element instance and their links. (The instances in the ElementDirectory must be of types defined in the DomainDataDirectory.)

From the store, you can navigate to the individual items in the store. You can get information about elements or types. You can also do the following tasks:

  • add items

  • delete items

  • modify existing elements and links and their properties

Whenever you modify a store, you must enclose any code that writes to the store in a Transaction. You can cancel all the changes to the store made in a transaction by doing a Rollback of the transaction or by not doing a Commit of the transaction.

The store has a RuleManager that contains functionality to subscribe to rules. The store can also subscribe to events.

The store also has an UndoManager which has members that allow you to undo and redo changes to the store. You generally do not have to create a new instance of a store, although you can and can read a model into it by deserializing a model into the new instance. Often, you get access to the store from the Store property of an element or link in the model. The event arguments of rules and events provide the element or link instance that the rule or event pertains to, and you can use its Store property to access the store and its TransactionManager.

The following examples show different ways to instantiate a store. When there are dependencies between domain models, as in the third example that follows, the domain models should be specified in order of dependency.

// Create a store with your domain models (classes in the generated 
// code derived from Microsoft.VisualStudio.Modeling.DomainModel).
Store store = new Store(typeof(ActivityDomainModel));

// Domain models can be loaded into the store after construction.
// Be sure to call store.Dispose() when you are done with it. 
Store store2 = new Store();

// Multiple domain models can be loaded into the store at once
Store store3 = new Store(typeof(BaseActivityDomainModel), typeof(ExtendedActivityDomainModel));

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.