RolePlayerChangeRule Class
Represents a rule that is called when a role player in the model changes.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.Modeling.Rule
Microsoft.VisualStudio.Modeling.RolePlayerChangeRule
Microsoft.VisualStudio.Modeling.Diagrams.BinaryLinkNodeChangeRule
Microsoft.VisualStudio.Modeling.Diagrams.NestedShapesParentRoleChangeRule
Microsoft.VisualStudio.Modeling.Diagrams.ParentRoleChangeRule
Namespace: Microsoft.VisualStudio.Modeling
Assembly: Microsoft.VisualStudio.Modeling.Sdk.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.11.0.dll)
Syntax
'Declaration
Public MustInherit Class RolePlayerChangeRule _
Inherits Rule
public abstract class RolePlayerChangeRule : Rule
public ref class RolePlayerChangeRule abstract : public Rule
[<AbstractClass>]
type RolePlayerChangeRule =
class
inherit Rule
end
public abstract class RolePlayerChangeRule extends Rule
The RolePlayerChangeRule type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
RolePlayerChangeRule |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
FireBefore | true if this rule will be executed before the change occurs. (Inherited from Rule.) |
|
FireImmediately | true if this rule will execute immediately the change occurs. (Inherited from Rule.) |
|
FireOnLocalCommit | true if this rule will execute when the current transaction commits. (Inherited from Rule.) |
|
FireOnTopLevelCommit | true if this rule will execute when the top level transaction commits. (Inherited from Rule.) |
|
FireTime | Gets or sets when the rule should execute. Normally set by the RuleOn attribute. (Inherited from Rule.) |
|
IsEnabled | Gets or sets whether the rule is enabled. Normally true by default, but you can initialize it to false in the RuleOn attribute. (Inherited from Rule.) |
|
Priority | Gets the priority that is assigned to the rule. Helps to determine the order in which rules are executed at the end of a transaction. (Inherited from Rule.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CompareTo(Object) | Compares the rule to another object. (Inherited from Rule.) |
|
CompareTo(Rule) | Compares the rule to another rule by their IDs. (Inherited from Rule.) |
|
Equals(Object) | Verifies whether the rule is equal to another object. (Inherited from Rule.) |
|
Equals(Rule) | Verifies whether a rule is equal to another rule. (Inherited from Rule.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Gets the hash code for the rule. (Inherited from Rule.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
RolePlayerChanged | Override this method to define the rule. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
Rules of this type are triggered when a new value is assigned to one of the roles of a domain relationship.
A RuleOnAttribute attribute placed on the class indicates what type of object the Rule works on and when the rule should fire (inline, local transaction commit, or top level transaction commit).
For more information and examples, see Rules Propagate Changes Within the Model.
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