Microsoft.VisualStudio.Modeling Namespace

 

The Modeling namespace deals with additions, deletions, and modifications of elements and links when a model is created or modified.

ClassDescription
System_CAPS_pubclassAddRule

Represents a rule that is called when an object is added to the model.

System_CAPS_pubclassAmbiguousMonikerException

The exception that is thrown when a model element to be added to the store has the same moniker as another element already in the store.

System_CAPS_pubclassAncestorVisitorFilter

Use with an ElementWalker to visit all aggregating relationships.

System_CAPS_pubclassBreadthFirstRolePlayerFirstElementWalker

Visits the elements in the model, applying an action to each one. The action can update or accumulate results from the elements that are visited.

System_CAPS_pubclassChainingElementVisitorFilter

Represents a chaining filter, which adds filters to a list.

System_CAPS_pubclassChangeRule

Represents a rule that is called when the value of a property of an element is changed.

System_CAPS_pubclassClosureContextHelper

Provides methods to add and retrieve closure context information to and from a particular element walker context.

System_CAPS_pubclassClosureElementOperation

Represents closure element operations.

System_CAPS_pubclassClosureFindAndRelateElementOperation

Represents a closure operation to mark a find or create target element operation.

System_CAPS_pubclassClosureFindAndRelateOrDeleteCopiedElementOperation

Represents a closure operation to find and relate to an element or delete the copied element if the target is not found.

System_CAPS_pubclassClosureFindElementOperation

Represents a closure operation that marks a find target element operation.

System_CAPS_pubclassClosureFindOrCreateAndRelateElementOperation

Represents a closure operation that marks a find or create target element operation.

System_CAPS_pubclassClosureFindOrCreateElementOperation

Represents a closure operation that marks a find or create target element operation.

System_CAPS_pubclassContext

Contains the mapping of transactions to partitions.

System_CAPS_pubclassCopyClosureFilter

Base class for copy closure visitor filter

System_CAPS_pubclassCopyOriginContext

Provides information about the origin of the ElementGroupPrototype.

System_CAPS_pubclassCoreCopyClosure

Copy closure visitor filter

System_CAPS_pubclassCoreCopyClosureBase

Base class for copy closure visitor filter

System_CAPS_pubclassCoreDeleteClosure

Remove closure visitor filter

System_CAPS_pubclassCoreDeleteClosureBase

Base class for remove closure visitor filter

System_CAPS_pubclassCoreDomainModel

Represents the domain model that defines the basic elements used by all domain models.

System_CAPS_pubclassCoreDomainModelSerializationBehavior

A DomainXmlSerializationBehavior implementation for defined behavior CoreDomainModelSerializationBehavior.

System_CAPS_pubclassDefaultVisitorFilter

Visits all aggregate relationships.

System_CAPS_pubclassDeleteRule

Represents a rule that is called when an object is deleted from the model. Executes after the corresponding DeletingRule.

System_CAPS_pubclassDeletingRule

Represents a rule that is called when an element is about to be deleted in the model.

System_CAPS_pubclassDependsOnDomainModelAttribute

Attribute class used to specify the domain model the current domain model extends.

System_CAPS_pubclassDepthFirstElementAndLinkWalker

Visits the elements in the model, applying an action to each one. Links can be included.

System_CAPS_pubclassDepthFirstElementWalker

Enables depth-first traversals of the model starting from a particular element or group of elements. Provides notification of begin and end traversing an element and its descendants.

System_CAPS_pubclassDeserializationEndingEventArgs

Provides data for the DeserializationEnding event and notifies listeners that deserialization has ended.

System_CAPS_pubclassDomainClassInfo

Represents a domain class.

System_CAPS_pubclassDomainClassXmlSerializer

Represents the base class for all generated domain serializers.

System_CAPS_pubclassDomainDataDirectory

Stores metadata about the domain models in the store.

System_CAPS_pubclassDomainDataNotFoundException

This exception is thrown by the DomainDataDirectory class when a domain element that has a specific identity is not found in the directory.

System_CAPS_protclassDomainModel.DomainMemberInfo

Stores information about a domain property in a domain model.

System_CAPS_pubclassDomainModel

Represents a domain model. This is the base class of the domain model of your DSL.

System_CAPS_pubclassDomainModelExtensionProvider

Defines the MEF contract for a type that provides a mapping between a domain model extension and the domain model it extends

System_CAPS_pubclassDomainModelInfo

Represents a domain model definition.

System_CAPS_pubclassDomainModelOwnerAttribute

In the code generated from a domain type, indicates the domain model in which a domain class is defined.F905

System_CAPS_pubclassDomainModelSerializerAttribute

Custom attribute used to indicate that a class is a domain model serializer, and the type of domain model it serializes.

System_CAPS_pubclassDomainObjectIdAttribute

Represents the ID of a domain object.

System_CAPS_pubclassDomainObjectInfo

Represents an element in a domain model.

System_CAPS_pubclassDomainPropertyAttribute

Indicates that the target is a domain property of a domain class.

System_CAPS_pubclassDomainPropertyInfo

Represents a property of a domain class.

System_CAPS_pubclassDomainPropertyXmlSerializer

The base class for all custom domain property serializers

System_CAPS_pubclassDomainRelationshipAttribute

Indicates that the target is a domain relationship.

System_CAPS_pubclassDomainRelationshipInfo

Represents the metadata about a domain relationship.

System_CAPS_pubclassDomainRelationshipXmlSerializer

Represents the base class for all generated domain serializers for domain relationships.

System_CAPS_pubclassDomainRoleAttribute

Indicates that the target is a domain role of a domain relationship.

System_CAPS_pubclassDomainRoleInfo

Represents a role of a domain relationship.

System_CAPS_protclassDomainModel.DomainRolePlayerInfo

Stores information that is used by the domain model reflector to locate a domain role.

System_CAPS_pubclassDomainXmlSerializationBehavior

Represents all XML serialization behavior-generated classes.

System_CAPS_pubclassDomainXmlSerializerDirectory

Combines XML serialization behaviors from different domain models together.

System_CAPS_pubclassDomainXmlSerializerDirectoryEntry

Associates one domain class ID to its DomainClassXmlSerializer type.

System_CAPS_pubclassDomainXmlSerializerNamespaceEntry

An tuple that links one Domain Model to its xml namepace type.

System_CAPS_pubclassDomainXmlTypeSerializerDirectoryEntry

An tuple that maps a type to the serializer type to use.

System_CAPS_pubclassElementAddedEventArgs

Provides data for the ElementAdded event.

System_CAPS_pubclassElementAddedEventManager

Manages element added events.

System_CAPS_pubclassElementClosureWalker

Represents a walker that builds closures on model elements.

System_CAPS_pubclassElementDeletedEventArgs

Provides data for the ElementDeleted event.

System_CAPS_pubclassElementDeletedEventManager

Manages element removed events.

System_CAPS_pubclassElementDeletingEventArgs

Provides data for the ElementDeleting event.

System_CAPS_pubclassElementDeserializedRule

A rule that fires when new ModelElements are created, used by SimpleMonikerResolver to monitor new elements.

System_CAPS_pubclassElementEventArgs

Provides data for notifications associated with a model element.

System_CAPS_pubclassElementEventManager

In derived classes, provides a mechanism for observers to register for and be notified of changes to an element within the scope of the store.

System_CAPS_pubclassElementEventsBegunEventArgs

Provides data for the ElementEventsBegun event.

System_CAPS_pubclassElementEventsBegunEventManager

Manages events that have begun for elements.

System_CAPS_pubclassElementEventsEndedEventArgs

Provides data for the ElementEventsEnded event.

System_CAPS_pubclassElementEventsEndedEventManager

Manages element events ended events.

System_CAPS_pubclassElementFactory

Represents a factory of domain model objects.

System_CAPS_pubclassElementGroup

Provides a way to collect elements and element links.

System_CAPS_pubclassElementGroupContext

Stores context information about an element group.

System_CAPS_pubclassElementGroupPrototype

Contains the information necessary to recreate a set of elements and links. Used to store elements in tools, on the clipboard, and in a drag operation.

System_CAPS_pubclassElementLink

Base class for all domain relationships.

System_CAPS_pubclassElementMovedEventArgs

Provides data for the ElementMoved event.

System_CAPS_pubclassElementMovedEventManager

Manages element moved events.

System_CAPS_pubclassElementNameAttribute

Indicates the target domain property provides the element name property.

System_CAPS_pubclassElementNameProvider

Represents a name provider for domain elements.

System_CAPS_pubclassElementOperations

Provides common operations that act upon a collection of model elements.

System_CAPS_pubclassElementPropertyChangedEventArgs

Provides data for the ElementPropertyChanged event.

System_CAPS_pubclassElementPropertyChangedEventManager

Manages element property changed events.

System_CAPS_pubclassElementWalker

Enables various traversals of the model starting from a particular element.

System_CAPS_pubclassEmbeddingVisitorFilter

Visits all embedding relationships.

System_CAPS_pubclassEventManagerDirectory

Enables you to add or remove custom code to run when an event is raised.

System_CAPS_pubclassExistingElementEventManager

In a derived class, manages element events.

System_CAPS_pubclassExtendsDomainModelAttribute

Obsolete.Indicates the domain model that this domain model extends.

System_CAPS_pubclassExtensionElement

Base class for all domain model element extensions. Allows a DSL Definition to be extended by a third party.

System_CAPS_pubclassExtensionElementSerializer

Serializer ExtensionElementSerializer for DomainClass ExtensionElement.

System_CAPS_pubclassExtensionExtendsElement

DomainRelationship ExtensionExtendsElement Reference relationship between ElementExtension and ModelElement

System_CAPS_pubclassExtensionExtendsElementSerializer

Serializer ExtensionExtendsElementSerializer for DomainClass ExtensionExtendsElement.

System_CAPS_pubclassGenericEventArgs

Abstract base class for all event arguments for element events.

System_CAPS_pubclassGlobalEventManager

When overridden in a derived class, enables observers to register for and be notified of changes within a store.

System_CAPS_pubclassInternalModelingErrorException

Represents the exception that is thrown when an internal error occurs inside the modeling engine.

System_CAPS_pubclassInvalidDomainModelException

Represents an exception that is thrown when an error is encountered with the metadata assigned to a domain model.

System_CAPS_pubclassISerializerLocatorExtensions

Provides convenience methods to extend the standard ISerializerLocator interface

System_CAPS_pubclassLinkedElementCollection<T>

Provides a collection of all elements that are linked to an element.

System_CAPS_pubclassMefMetadataConstants

Defines the string constants for the names of domain model MEF metadata keys

System_CAPS_pubclassMergeAbortedException

Represents an exception that is thrown when a merge operation on a domain model is aborted by the user.

System_CAPS_pubclassMergeContext

Provides merge information initially set by the merge process when the objects of a ElementGroupPrototype are reconstituted into the target store.

System_CAPS_pubclassMergeElementGroupEventArgs

Provides data for the MergeElementGroup event.

System_CAPS_pubclassModelElement

The base class for all domain model elements. All elements and links in a DomainModel are members of this type.

System_CAPS_pubclassModelingEventArgs

Provides data for modeling events.

System_CAPS_pubclassModelingException

Represents the base class for several exceptions thrown by the modeling engine.

System_CAPS_pubclassMoniker

Contains an expression used to map to its element.

System_CAPS_pubclassMonikerKey

Represents the key of a Moniker.

System_CAPS_pubclassMoveRule

Represents a rule that is called when an object is moved in the model.

System_CAPS_pubclassPartition

Provides a logical container for elements in a store.

System_CAPS_pubclassPartitionDictionary

Represents a collection of partitions.

System_CAPS_pubclassPropagateDeleteVisitorFilter

Visits all PropagateRemove relationships.

System_CAPS_pubclassPropertyAssignment

Represents a property assignment pair that consists of property ID and a property value.

System_CAPS_pubclassProtoElement

Represents the prototype class for an element.

System_CAPS_pubclassProtoElementBase

Represents the prototype for the element.

System_CAPS_pubclassProtoGroup

Contains the information to re-create an ElementGroup in the context of any store.

System_CAPS_pubclassProtoLink

Contains the information needed to recreate an ElementLink in any store.

System_CAPS_pubclassProtoPropertyValue

Contains the information necessary to populate an attribute value for a particular model element.

System_CAPS_pubclassProtoRolePlayer

Contains the data necessary to set the role player data on an ElementLink.

System_CAPS_pubclassProvidesExtensionToDomainModelAttribute

Custom attribute used to indicate that a domain model is an extension of another domain model.

System_CAPS_pubclassReadOnlyLinkedElementCollection<T>

Represents a strongly-typed read-only collection of element instances on the opposite side of a relationship.

System_CAPS_pubclassRedoStackFlushedEventArgs

Event args for the RedoStackFlushed event.

System_CAPS_pubclassRoleAssignment

Provides information to initialize a role that is assigned to a link element.

System_CAPS_pubclassRolePlayerChangedEventArgs

Provides data for the RolePlayerChanged event.

System_CAPS_pubclassRolePlayerChangedEventManager

Manages events that are changed by the role.

System_CAPS_pubclassRolePlayerChangeRule

Represents a rule that is called when a role player in the model changes.

System_CAPS_pubclassRolePlayerOrderChangedEventArgs

Provides data for the RolePlayerOrderChanged event.

System_CAPS_pubclassRolePlayerOrderChangedEventManager

Manages events that are changed when the order of the model elements that are assigned to roles change.

System_CAPS_pubclassRolePlayerPositionChangeRule

Represents a rule that is called when a model element that is assigned to a specific role changes position in a multiple relationship.

System_CAPS_pubclassRootElementSettings

Similar to System.Xml.XmlWriterSettings, this class stores settings that need to be passed to a serializer when serializing a root element. Root element has additional information like schema target namespace, versions, etc., so additional information may be needed.

System_CAPS_pubclassRule

Abstract class from which different types of store rule can be derived.

System_CAPS_pubclassRuleManager

Controls whether rules are enabled or disabled.

System_CAPS_pubclassRuleOnAttribute

Signifies that the class to which this attribute is applied is a rule. The attribute’s parameter specifies what domain class applies to.

System_CAPS_pubclassSerializationContext

Defines the context of a serialization operation.

System_CAPS_pubclassSerializationContextTransactionExtensions

Extension methods for accessing SerializationContext in the scope of a Transaction

System_CAPS_pubclassSerializationException

Throws a SerializationResult as an exception.

System_CAPS_pubclassSerializationMessage

Represents a serialization message.

System_CAPS_pubclassSerializationResult

Represents a serialization result.

System_CAPS_pubclassSerializationUtilities

Provides utilities for serialization.

System_CAPS_pubclassSimpleMonikerResolver

Resolves simple string references when the model is serialized using the default XML serialization.

System_CAPS_pubclassStandardExtensionLocator

Standard implementation of the IExtensionLocator interface

System_CAPS_pubclassStandardSerializerLocator

Standard implementation of the ISerializerLocator interface

System_CAPS_pubclassStore

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

System_CAPS_pubclassTransaction

A transaction makes sure that changes that were made to the store are treated as a group that can be committed or rolled back.

System_CAPS_pubclassTransactionBeginningEventArgs

Provides data for the TransactionBeginning event.

System_CAPS_pubclassTransactionBeginningEventManager

Manages transaction beginning events.

System_CAPS_pubclassTransactionBeginningRule

Represents a rule that is called when a transaction is beginning in the model.

System_CAPS_pubclassTransactionCommitEventArgs

Provides data for the TransactionCommit event.

System_CAPS_pubclassTransactionCommittedEventManager

Manages transaction committed events.

System_CAPS_pubclassTransactionCommittingRule

Represents a rule that is called when a transaction is in progress in the model.

System_CAPS_pubclassTransactionContext

Stores user data in a transaction.

System_CAPS_pubclassTransactionEventArgs

Provides data for transaction events.

System_CAPS_pubclassTransactionEventManager

Represents the base class for managing notifications of transaction events.

System_CAPS_pubclassTransactionItem

Represents a transaction item.

System_CAPS_pubclassTransactionLog

Represents a container of transaction events.

System_CAPS_pubclassTransactionManager

Creates Transaction objects and keeps track of the current active transaction.

System_CAPS_pubclassTransactionRollbackEventArgs

System_CAPS_pubclassTransactionRolledBackEventManager

Manages transaction rollback events.

System_CAPS_pubclassTransactionRollingBackRule

Represents a rule that is called when a transaction is being rolled back in the model.

System_CAPS_pubclassUndoItemEventArgs

Provides data for the UndoItem event.

System_CAPS_pubclassUndoManager

Provides the functionality for undo and redo operations.

System_CAPS_pubclassUndoRedoCanceledException

Represents the exception that is thrown when an undo or redo operation has been canceled.

System_CAPS_pubclassVisitorFilters

Returns various standard visitor filters.

StructureDescription
System_CAPS_pubstructureReadOnlyLinkedElementCollection<T>.Enumerator

Provides an enumerator over a ReadOnlyLinkedElementCollection

InterfaceDescription
System_CAPS_pubinterfaceIDomainModelSerializer

Defines the contract for a standard domain model serializer.

System_CAPS_pubinterfaceIElementDirectory

Directory of model elements that are contained within a store or a partition.

System_CAPS_pubinterfaceIElementPartitionMapper

Interface for service used to map elements partitions when reconstituting ElementGroupPrototypes

System_CAPS_pubinterfaceIElementVisitor

Defines the traversal of a model.

System_CAPS_pubinterfaceIElementVisitorFilter

Provides a callback mechanism for filtering out which role players and which relationships should be visited during traversal by an ElementWalker.

System_CAPS_pubinterfaceIExtensionLocator

This interface provides a way for the generated serializers to resolve a schema target namespace to a domain model.

System_CAPS_pubinterfaceIMergeElements

Allows classes in derived models to access the merge functionality on a model element.

System_CAPS_pubinterfaceIMonikerResolver

Resolves a moniker to its element.

System_CAPS_pubinterfaceISchemaResolver

This interface provides a way for the generated serializers to resolve a schema target namespace. Given an XML file using a particular target namespace, it is important to find the schemas that define the namespace, so the generated serializers can do schema validations properly.

System_CAPS_pubinterfaceISerializerLocator

This interface provides a way to locate serializers for a domain model.

System_CAPS_pubinterfaceITransientTransactionContextObject

Interface marker to indicate that a particular object is transient and will be released (and disposed) on transaction commit

System_CAPS_pubinterfaceSElementPartitionMapper

Service identifier for the element group rehydration partition mapping service

DelegateDescription
System_CAPS_pubdelegateCanCommitCallback

Represents a callback method for determining whether a transaction can commit based on external criteria.

System_CAPS_pubdelegateCanUndoRedoCallback

Add an instance to the UndoManager to vote on whether an undo or redo operation can continue.

EnumerationDescription
System_CAPS_pubenumCanCommitResult

Enumeration status for the CanCommit callback.

System_CAPS_pubenumChangeSource

Indicates the source of a change that was made during a transaction.

System_CAPS_pubenumClosureType

Describes the type of closure to create.

System_CAPS_pubenumCompletionStatus

Describes how the transaction was completed.

System_CAPS_pubenumDeleteState

Identifies the state of the element being deleted.

System_CAPS_pubenumDomainPropertyKind

Specifies the type of domain property.

System_CAPS_pubenumDomainRoleOrder

Specifies the direction of a domain role in a domain relationship.

System_CAPS_pubenumMultiplicity

Indicates the multiplicity for a domain role.

System_CAPS_pubenumPropagatesCopyOption

Enum that lists the various PropagateCopy options.

System_CAPS_pubenumSerializationMessageKind

Formats the serialization message.

System_CAPS_pubenumTimeToFire

Determines when to call the rule.

System_CAPS_pubenumUndoState

Describes the undo state in the UndoManager.

System_CAPS_pubenumVisitorFilterResult

Indicates whether an element should be visited.

The Modeling namespace classes allow your code to create and modify elements and links within transactions. The Store is the class that represents the contents (elements and links) of a model in memory. Whenever you programmatically make changes to a model, these changes must be done within a Transaction.

You can define rules that are run when certain things happen, such as an element or a link being added, changed, or deleted.

You can also subscribe to be notified when an event such as a transaction being rolled back occurs.

The difference between rules and events is that rules are fired within a transaction while events are fired after a transaction is committed.

Return to top
Show: