Share via


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.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.12.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
Public property BaseDomainRole Gets the base domain role for this role.
Public property DisplayName Gets the display name of the element. (Inherited from DomainObjectInfo.)
Public property DomainModel Gets the domain model that contains information about this role. (Overrides DomainObjectInfo.DomainModel.)
Public property DomainRelationship Gets the domain relationship that this domain role belongs to.
Public property Id Gets the ID of the element. (Inherited from DomainObjectInfo.)
Public property 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.
Public property IsMany Gets the domain role and verifies whether the multiplicity allows multiple objects.
Public property IsOne Gets the domain role and verifies whether the multiplicity allows a maximum of one object.
Public property IsOptional Gets the domain role and verifies whether the multiplicity allows zero objects. If it does allow zero objects, this makes it optional.
Public property IsSource Gets the domain role and verifies that it is source code.
Public property LinkPropertyInfo Gets the property information for this domain role.
Public property Multiplicity Gets the multiplicity of this role.
Public property Name Gets the name of the element. (Inherited from DomainObjectInfo.)
Public property OppositeDomainRole Gets the domain role opposite this domain role in the domain relationship.
Public property 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.
Public property 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.
Public property PropertyDisplayName Gets the name of the property that is displayed to the user on the diagram.
Public property PropertyName Gets the name of the accessor property for this role on the role player domain class.
Public property RolePlayer Gets the domain class that plays this role.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic member GetAllElementLinks Gets a list of all element links that the given element participates in.
Public method GetElementLinks(ModelElement) Gets element links when a given element plays this role.
Public method GetElementLinks(ModelElement, Boolean) Gets element links when a given element plays this role.
Public method GetElementLinks<T>(ModelElement) Gets a list of elements that are linked to a role.
Public method GetElementLinks<T>(ModelElement, Boolean) Gets element links when a given element plays this role.
Public methodStatic member GetElementLinks<T>(ModelElement, Guid) Gets element links when a given element plays a given role.
Public method GetElementLinksToElement(ModelElement, ModelElement) Gets the links between a source and a target element.
Public method GetElementLinksToElement(ModelElement, ModelElement, Boolean) Gets the links between a source and target element.
Public method GetElementLinksToElement<T>(ModelElement, ModelElement) Gets the links between a source and a target element.
Public method GetElementLinksToElement<T>(ModelElement, ModelElement, Boolean) Gets a collection of links between a source and target role.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetLinkedElement(ModelElement) Gets the element linked to this element in the relationship.
Public methodStatic member GetLinkedElement(ModelElement, Guid) Gets the element that is linked to this element.
Public method GetLinkedElements Gets a list of elements that are linked to this role.
Public method GetRolePlayer(ElementLink) Gets the link role player that corresponds to this role.
Public methodStatic member GetRolePlayer(ElementLink, Guid) Gets the specified role player from a link.
Public method GetRolePlayerMoniker Gets the link role player moniker corresponding to this role.
Public methodStatic member GetSourceRolePlayer Gets the source element that is attached to a link.
Public methodStatic member GetTargetRolePlayer Gets the target element that is attached to a link.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method SetLinkedElement(ModelElement, ModelElement) Sets the element on the other side of the relationship.
Public methodStatic member SetLinkedElement(ModelElement, Guid, ModelElement) Sets the link role player on the other side of the relationship.
Public method SetRolePlayer(ElementLink, ModelElement) Sets the link role player that corresponds to this role.
Public methodStatic member SetRolePlayer(ElementLink, Guid, ModelElement) Assigns an element to a role in a relationship.
Public method SetRolePlayerMoniker(ElementLink, Moniker) Sets the link role player moniker corresponding to this role.
Public methodStatic member SetRolePlayerMoniker(ElementLink, Guid, Moniker) Sets a specified role player on a link.
Public method 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