Rule Class

 

Abstract class from which different types of store rule can be derived.

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


public ref class Rule abstract : IComparable, IComparable<Rule^>

NameDescription
System_CAPS_protmethodRule()

Initializes a new instance of the Rule class.

NameDescription
System_CAPS_pubpropertyFireBefore

true if this rule will be executed before the change occurs.

System_CAPS_pubpropertyFireImmediately

true if this rule will execute immediately the change occurs.

System_CAPS_pubpropertyFireOnLocalCommit

true if this rule will execute when the current transaction commits.

System_CAPS_pubpropertyFireOnTopLevelCommit

true if this rule will execute when the top level transaction commits.

System_CAPS_pubpropertyFireTime

Gets or sets when the rule should execute. Normally set by the RuleOn attribute.

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.

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.

NameDescription
System_CAPS_pubmethodCompareTo(Object^)

Compares the rule to another object.

System_CAPS_pubmethodCompareTo(Rule^)

Compares the rule to another rule by their IDs.

System_CAPS_pubmethodEquals(Object^)

Verifies whether the rule is equal to another object.(Overrides Object::Equals(Object^).)

System_CAPS_pubmethodEquals(Rule^)

Verifies whether a rule is equal to another rule.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Gets the hash code for the rule.(Overrides Object::GetHashCode().)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticEquality(Rule^, Rule^)

Verifies whether two rules are equal.

System_CAPS_puboperatorSystem_CAPS_staticGreaterThan(Rule^, Rule^)

Used to sort rules into order by ID.

System_CAPS_puboperatorSystem_CAPS_staticInequality(Rule^, Rule^)

Verifies whether two rules are not equal.

System_CAPS_puboperatorSystem_CAPS_staticLessThan(Rule^, Rule^)

Used to sort rules into order by ID.

To define a rule that propagates changes in the store, derive a class from one of this class’s derived classes such as AddRule. Apply the rule to a domain class using the RuleOn attribute.

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: