DeletingRule Class
 

Represents a rule that is called when an element is about to be deleted in the model.

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

SystemObject
   Microsoft.VisualStudio.ModelingRule
    Microsoft.VisualStudio.ModelingDeletingRule

public abstract class DeletingRule : Rule
public ref class DeletingRule abstract : Rule
[<AbstractClass>]
type DeletingRule = 
    class
        inherit Rule
    end
Public MustInherit Class DeletingRule
	Inherits Rule
NameDescription
System_CAPS_protmethod DeletingRule

NameDescription
System_CAPS_pubproperty

Override the FireBefore flag to always return true(Overrides .)

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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_pubproperty

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_pubmethod CompareTo

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

System_CAPS_pubmethod CompareTo

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

System_CAPS_pubmethod ElementDeleting

public virtual method for the client to have his own user-defined delete rule class

System_CAPS_pubmethod Equals

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

System_CAPS_pubmethod Equals

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

System_CAPS_protmethod Finalize

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode

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

System_CAPS_pubmethod GetType

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone

(Inherited from Object.)

System_CAPS_pubmethod ToString

(Inherited from Object.)

Rules of this type are triggered when an element is about to be deleted from the store.

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.

The rule is called when the object of the specified type is about to be deleted from the model, whether it is deleted in the UI or programmatically.

A DeletingRule is always executed before a DeleteRuledefined on the same object. Typically, all the deleting rules generated by a transaction are executed, and then all the deleted rules.

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