DeleteRule Class

 

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

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


public ref class DeleteRule abstract : Rule

NameDescription
System_CAPS_protmethodDeleteRule()

Initializes a new instance of the DeleteRule class.

NameDescription
System_CAPS_pubpropertyFireBefore

true if this rule will be executed before the change occurs.(Inherited from Rule.)

System_CAPS_pubpropertyFireImmediately

true if this rule will execute immediately the change occurs.(Inherited from Rule.)

System_CAPS_pubpropertyFireOnLocalCommit

true if this rule will execute when the current transaction commits.(Inherited from Rule.)

System_CAPS_pubpropertyFireOnTopLevelCommit

true if this rule will execute when the top level transaction commits.(Inherited from Rule.)

System_CAPS_pubpropertyFireTime

Gets or sets when the rule should execute. Normally set by the RuleOn attribute.(Inherited from Rule.)

System_CAPS_pubpropertyIsEnabled

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.)

System_CAPS_pubpropertyPriority

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.)

NameDescription
System_CAPS_pubmethodCompareTo(Object^)

Compares the rule to another object.(Inherited from Rule.)

System_CAPS_pubmethodCompareTo(Rule^)

Compares the rule to another rule by their IDs.(Inherited from Rule.)

System_CAPS_pubmethodElementDeleted(ElementDeletedEventArgs^)

Alerts listeners that an element has been deleted from the model.

System_CAPS_pubmethodEquals(Object^)

Verifies whether the rule is equal to another object.(Inherited from Rule.)

System_CAPS_pubmethodEquals(Rule^)

Verifies whether a rule is equal to another rule.(Inherited from Rule.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Gets the hash code for the rule.(Inherited from Rule.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

Rules of this type are triggered when an object is deleted from the model.

Before defining a Delete Rule, consider whether you can achieve the same effect using the features available in the DSL Definition. For more information, see Customizing Deletion Behavior 

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).

The rule is executed when the object of the specified type is deleted from the model, whether it is deleted in the UI or programmatically. It is always executed after a DeletingRule defined on the same object. Typically, all the deleting rules generated by a transaction are executed, and then all the deleted rules.

If you want to delete further objects in response to an object’s deletion, do so in a DeletingRule, not a DeleteRule.

After the DeleteRule is triggered, the IsDeleted property of the element is true. The element is removed from the store’s element directory.

For more information and examples, see Rules Propagate Changes Within the Model.

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

Return to top
Show: