DomainRelationship Class

Definition

Namespace:

Microsoft.VisualStudio.Modeling.DslDefinition

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.15.0.dll

DomainClass DomainRelationship Defines a relationship between two domain classes.

public ref class DomainRelationship sealed : Microsoft::VisualStudio::Modeling::DslDefinition::DomainClass

[Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.DomainRelationship.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.DomainRelationship.DisplayName", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel))]
[Microsoft.VisualStudio.Modeling.DomainObjectId("2a261c82-59a1-4d5d-979a-afc5ec891eff")]
[Microsoft.VisualStudio.Modeling.Validation.ValidationState(Microsoft.VisualStudio.Modeling.Validation.ValidationState.Enabled)]
[System.CLSCompliant(true)]
public sealed class DomainRelationship : Microsoft.VisualStudio.Modeling.DslDefinition.DomainClass

[<Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.DomainRelationship.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.DomainRelationship.DisplayName", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel))>]
[<Microsoft.VisualStudio.Modeling.DomainObjectId("2a261c82-59a1-4d5d-979a-afc5ec891eff")>]
[<Microsoft.VisualStudio.Modeling.Validation.ValidationState(Microsoft.VisualStudio.Modeling.Validation.ValidationState.Enabled)>]
[<System.CLSCompliant(true)>]
type DomainRelationship = class
    inherit DomainClass

Public NotInheritable Class DomainRelationship
Inherits DomainClass

Inheritance

Object

ModelElement

DomainElement

AttributedDomainElement

NamedDomainElement

DomainClass

DomainRelationship

Attributes

DescriptionResourceAttribute DisplayNameResourceAttribute DomainModelOwnerAttribute DomainObjectIdAttribute ValidationStateAttribute CLSCompliantAttribute

Constructors

DomainRelationship(Partition, PropertyAssignment[])	Constructor
DomainRelationship(Store, PropertyAssignment[])	Constructor

Fields

AllowsDuplicatesDomainPropertyId	AllowsDuplicates domain property Id.
DomainClassId	DomainRelationship domain class Id.
IsEmbeddingDomainPropertyId	IsEmbedding domain property Id.
IsNameTrackingDomainPropertyId	IsNameTracking domain property Id.

Properties

AccessModifier	Gets or sets the value of AccessModifier domain property. Determines if the access modifier for the domain class is public or internal. (Inherited from DomainClass)
AllDescendants	Gets a read-only list of all domain classes directly or indirectly derived form this one. (Inherited from DomainClass)
AllowsDuplicates	Gets or sets the value of AllowsDuplicates domain property. If True, permits duplicate links of this domain relationship to be created between the same two elements.
AllProperties	The set of all DomainProperties both defined on this class and inherited from base classes (Inherited from DomainClass)
AllRolesPlayed	The set of all DomainRoles both played directly by this class and inherited from base classes (Inherited from DomainClass)
Attributes	Gets a list of Attributes. (Inherited from AttributedDomainElement)
BaseClass	Gets or sets BaseClass. The base relationship of this domain relationship.
ClassData	Gets or sets ClassData. Xml serialization configuration data for the domain class. (Inherited from DomainClass)
CustomAttributes	Gets or sets the value of CustomAttributes domain property. Used to attribute the code generated from this element. (Inherited from AttributedDomainElement)
CustomTypeDescriptor	Gets or sets CustomTypeDescriptor. Definition of the custom type descriptor for the class. (Inherited from DomainClass)
Description	Gets or sets the value of Description domain property. Used in the UI and in the code documentation of the generated designer. (Inherited from AttributedDomainElement)
DisplayName	Gets or sets the value of DisplayName domain property. The name that will be displayed in the generated designer for this element. (Inherited from NamedDomainElement)
DslLibrary	Gets or sets DslLibrary. Dsl library defining the reference type. (Inherited from DomainClass)
ElementMergeDirectives	Gets a list of ElementMergeDirectives. (Inherited from DomainClass)
GeneratesDoubleDerived	Gets or sets the value of GeneratesDoubleDerived domain property. If True, will generate both a base class with all functionality and a partial class to support customization through overrides. (Inherited from DomainClass)
HasCustomConstructor	Gets or sets the value of HasCustomConstructor domain property. If True, indicates that a custom constructor will be provided in code. (Inherited from DomainClass)
HelpKeyword	Gets or sets the value of HelpKeyword domain property. Optional keyword used to index F1 help for this element. (Inherited from NamedDomainElement)
Id	Unique identifier of this element. (Inherited from ModelElement)
InheritanceModifier	Gets or sets the value of InheritanceModifier domain property. Determines if the inheritance modifier of the .Net class generated from the domain class is none, abstract or sealed. (Inherited from DomainClass)
IsActive	Returns true if the Element is currently active within the model, false if the element has been deleted or is in the process of being deleted. (Inherited from ModelElement)
IsDeleted	Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement)
IsDeleting	Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement)
IsDescriptionTracking	Gets or sets the value of IsDescriptionTracking domain property. If True, the Description property tracks other data in the DSL definition. (Inherited from AttributedDomainElement)
IsDisplayNameTracking	Gets or sets the value of IsDisplayNameTracking domain property. If True, the DisplayName property tracks other data in the DSL definition. (Inherited from NamedDomainElement)
IsEmbedding	Gets or sets the value of IsEmbedding domain property. Indicates whether the relationship is an embedding or reference relationship.
IsNamespaceTracking	Gets or sets the value of IsNamespaceTracking domain property. If True, the Namespace property tracks other data in the DSL definition. (Inherited from DomainClass)
IsNameTracking	Gets or sets the value of IsNameTracking domain property. If True, the Name property tracks other data in the DSL definition.
Name	Gets or sets the value of Name domain property. Name of this element. (Inherited from NamedDomainElement)
Namespace	Gets or sets the value of Namespace domain property. Namespace affiliated with this domain class. (Inherited from DomainClass)
Notes	Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement)
Partition	Gets or sets the Partition instance that contains this element. (Inherited from ModelElement)
Properties	Gets a list of Properties. (Inherited from DomainClass)
ProxyIsNameTracking	Virtualized version of IsNameTracking to cope with the fact that derived classes own the IsNameTracking flags (Inherited from NamedDomainElement)
Roles	Gets a list of Roles. Roles of the relationship. There should be exactly two.
RolesPlayed	Gets a list of RolesPlayed. Roles played by the class. (Inherited from DomainClass)
Source	Gets or sets Source. Source role of the relationship.
Store	Get the Store instance that contains this element. (Inherited from ModelElement)
SubClasses	Gets a list of SubClasses.
Target	Gets or sets Target. Target role of the relationship.
XmlRelationshipData	Gets or sets XmlRelationshipData. Xml serialization configuration data for the domain relationship.

Methods

CalculateDescription()	Calculate the value of Description (Inherited from DomainClass)
CalculateName()	Calculates the value of Name (Inherited from NamedDomainElement)
CanMerge(ProtoElementBase, ElementGroupPrototype)	Returns a value indicating whether the source element represented by the specified root ProtoElement can be added to this element. (Inherited from DomainClass)
ChooseMergeTarget(ElementGroup)	Gets the ModelElement to be used as the target for the ElementGroup merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (Inherited from ModelElement)
ChooseMergeTarget(ElementGroupPrototype)	Gets the ModelElement to be used as the target for the ElementGroupPrototype merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (Inherited from ModelElement)
Copy()	Creates a copy of the element in the model. (Inherited from ModelElement)
Copy(IEnumerable<Guid>)	Creates a copy of the element in the model. (Inherited from ModelElement)
Delete()	Deletes the element from the model. (Inherited from ModelElement)
Delete(Guid[])	Deletes the element from the model. (Inherited from ModelElement)
GetDomainClass()	Gets the most-derived domain class for this element. (Inherited from ModelElement)
GetFullName(Boolean)	Gets the fully qualified name for this class (Inherited from DomainClass)
GetRelativeName(String, Boolean)	Gets the name of the domain class relative to the current namespace. If the current namespace is the same as this.Namespace, then we return this.Name. If not, we return this.GetFullName() (Inherited from DomainClass)
GetRoleCollection<TCollection,TElement>(Guid)	Gets or creates the linked element collection (Inherited from ModelElement)
IsDerivedFrom(DomainClass)	Test if this class is derived from the given class. (Inherited from DomainClass)
MergeConfigure(ElementGroup)	Configure a newly merged DomainClass (Inherited from DomainClass)
MergeDisconnect(ModelElement)	Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from DomainClass)
MergeRelate(ModelElement, ElementGroup)	Called by the Merge process to create a relationship between this target element and the specified source element. Typically, a parent-child relationship is established between the target element (the parent) and the source element (the child), but any relationship can be established. (Inherited from DomainClass)
OnCopy(ModelElement)	Called when a copy of the element has been created. The method is called on the duplicate element. (Inherited from ModelElement)
OnDeleted()	Called by the model after the element has been deleted. (Inherited from ModelElement)
OnDeleting()	Called by the model before the element is deleted. (Inherited from ModelElement)
OnInheritanceModifierChanged(InheritanceModifier, InheritanceModifier)	Called when InheritanceModifier on a DomainClass changes (Inherited from DomainClass)
OnNameChanged(String, String)	Called when a DomainClass' Name changes (Inherited from DomainClass)
OnNamespaceChanged(String, String)	Called when the Namespace of a DomainClass changes (Inherited from DomainClass)
OnResurrected()	Called by the model after the element has been resurrected (placed back into the store). (Inherited from ModelElement)
OnRolePlayerPositionChanged(DomainRoleInfo, ElementLink, Int32, Int32)	Virtual method for notifying when role player position has changed. (Inherited from ModelElement)
OnRolePlayerPositionChanging(DomainRoleInfo, ElementLink, Int32, Int32)	Virtual method for notifying when role player position will be changing. (Inherited from ModelElement)

Explicit Interface Implementations

IMergeElements.CanMerge(ProtoElementBase, ElementGroupPrototype)	(Inherited from ModelElement)
IMergeElements.ChooseMergeTarget(ElementGroup)	(Inherited from ModelElement)
IMergeElements.ChooseMergeTarget(ElementGroupPrototype)	(Inherited from ModelElement)
IMergeElements.MergeConfigure(ElementGroup)	(Inherited from ModelElement)
IMergeElements.MergeDisconnect(ModelElement)	(Inherited from ModelElement)
IMergeElements.MergeRelate(ModelElement, ElementGroup)	(Inherited from ModelElement)

Extension Methods

AddExtension(ModelElement, DomainClassInfo)	Extend this ModelElement with a newly instantiated extension of the specified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type.
AddExtension(ModelElement, ExtensionElement)	Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type.
AddExtension(ModelElement, Guid)	Extend this ModelElement with newly instantiated extension of the identified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type.
AddExtension(ModelElement, Type)	Extend this ModelElement with a newly instantiated extension of the specified type. An InvalidOperationException will be thrown if the element already has an extension of that type.
AddExtension<T>(ModelElement)	Extend this ModelElement with a newly instantiated extension of a particular type. An InvalidOperationException will be thrown if the element already has an extension of the same type.
GetAllExtensions(ModelElement)	Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement.
GetBaseElement(ModelElement)	Returns the root of the virtual MEL in which the specified ModelElement is participating.
GetExtension(ModelElement, DomainClassInfo)
GetExtension(ModelElement, Guid)
GetExtension(ModelElement, Type)	Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised.
GetExtension<T>(ModelElement)	Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised.
IsExtendedBy(ModelElement, DomainClassInfo)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
IsExtendedBy(ModelElement, Guid)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
IsExtendedBy(ModelElement, Type)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
RemoveExtension(ModelElement, DomainClassInfo)	Remove any extension of the specified ModelElement that is of a particular type.
RemoveExtension(ModelElement, ExtensionElement)	Remove a specified ExtensionElement from the extensions of this ModelElement.
RemoveExtension(ModelElement, Guid)	Remove any extension of the specified ModelElement that is of a particular type.
RemoveExtension(ModelElement, Type)	Remove any extension of this ModelElement that is of a particular type.
TryGetExtension(ModelElement, DomainClassInfo)
TryGetExtension(ModelElement, Guid)
TryGetExtension(ModelElement, Type)
TryGetExtension<T>(ModelElement)	Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If this element has no such extension then the result will be null.
CanDelete(ModelElement, Guid[])	Deletes the element from the model.
GetLocks(ModelElement)	Get the lock flags for this element. This will include any locks enabled on the Partition containing the element.
IsLocked(ModelElement, Locks)	Test whether this element has any of a specified set of locks
SetLocks(ModelElement, Locks)	Set the lock flags of this element