DomainRoleInfo Class

Represents a role of a domain relationship.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.DomainObjectInfo
    Microsoft.VisualStudio.Modeling.DomainRoleInfo

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

Syntax

'Declaration
Public NotInheritable Class DomainRoleInfo _
    Inherits DomainObjectInfo

public sealed class DomainRoleInfo : DomainObjectInfo

public ref class DomainRoleInfo sealed : public DomainObjectInfo

[<Sealed>]
type DomainRoleInfo =  
    class
        inherit DomainObjectInfo
    end

public final class DomainRoleInfo extends DomainObjectInfo

The DomainRoleInfo type exposes the following members.

Properties

	Name	Description
	BaseDomainRole	Gets the base domain role for this role.
	DisplayName	Gets the display name of the element. (Inherited from DomainObjectInfo.)
	DomainModel	Gets the domain model that contains information about this role. (Overrides DomainObjectInfo.DomainModel.)
	DomainRelationship	Gets the domain relationship that this domain role belongs to.
	Id	Gets the ID of the element. (Inherited from DomainObjectInfo.)
	IsEmbedding	Gets the domain role and verifies whether the player of this role logically contains the players of the other role or roles in this relationship.
	IsMany	Gets the domain role and verifies whether the multiplicity allows multiple objects.
	IsOne	Gets the domain role and verifies whether the multiplicity allows a maximum of one object.
	IsOptional	Gets the domain role and verifies whether the multiplicity allows zero objects. If it does allow zero objects, this makes it optional.
	IsSource	Gets the domain role and verifies that it is source code.
	LinkPropertyInfo	Gets the property information for this domain role.
	Multiplicity	Gets the multiplicity of this role.
	Name	Gets the name of the element. (Inherited from DomainObjectInfo.)
	OppositeDomainRole	Gets the domain role opposite this domain role in the domain relationship.
	PropagatesCopy	Gets the domain role and verifies whether the element playing this role in a link will be copied when the opposite role player element is copied.
	PropagatesDelete	Gets the domain role and verifies whether the element playing this role in a link will be deleted when the opposite role player element or the link itself is deleted.
	PropertyDisplayName	Gets the name of the property that is displayed to the user on the diagram.
	PropertyName	Gets the name of the accessor property for this role on the role player domain class.
	RolePlayer	Gets the domain class that plays this role.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAllElementLinks	Gets a list of all element links that the given element participates in.
	GetElementLinks(ModelElement)	Gets element links when a given element plays this role.
	GetElementLinks(ModelElement, Boolean)	Gets element links when a given element plays this role.
	GetElementLinks<T>(ModelElement)	Gets a list of elements that are linked to a role.
	GetElementLinks<T>(ModelElement, Boolean)	Gets element links when a given element plays this role.
	GetElementLinks<T>(ModelElement, Guid)	Gets element links when a given element plays a given role.
	GetElementLinksToElement(ModelElement, ModelElement)	Gets the links between a source and a target element.
	GetElementLinksToElement(ModelElement, ModelElement, Boolean)	Gets the links between a source and target element.
	GetElementLinksToElement<T>(ModelElement, ModelElement)	Gets the links between a source and a target element.
	GetElementLinksToElement<T>(ModelElement, ModelElement, Boolean)	Gets a collection of links between a source and target role.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLinkedElement(ModelElement)	Gets the element linked to this element in the relationship.
	GetLinkedElement(ModelElement, Guid)	Gets the element that is linked to this element.
	GetLinkedElements	Gets a list of elements that are linked to this role.
	GetRolePlayer(ElementLink)	Gets the link role player that corresponds to this role.
	GetRolePlayer(ElementLink, Guid)	Gets the specified role player from a link.
	GetRolePlayerMoniker	Gets the link role player moniker corresponding to this role.
	GetSourceRolePlayer	Gets the source element that is attached to a link.
	GetTargetRolePlayer	Gets the target element that is attached to a link.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetLinkedElement(ModelElement, ModelElement)	Sets the element on the other side of the relationship.
	SetLinkedElement(ModelElement, Guid, ModelElement)	Sets the link role player on the other side of the relationship.
	SetRolePlayer(ElementLink, ModelElement)	Sets the link role player that corresponds to this role.
	SetRolePlayer(ElementLink, Guid, ModelElement)	Assigns an element to a role in a relationship.
	SetRolePlayerMoniker(ElementLink, Moniker)	Sets the link role player moniker corresponding to this role.
	SetRolePlayerMoniker(ElementLink, Guid, Moniker)	Sets a specified role player on a link.
	ToString	Converts the element to a string. (Inherited from DomainObjectInfo.)

Top

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Modeling Namespace