RuleOnAttribute Class

Signifies that the class to which this attribute is applied is a rule. The attribute’s parameter specifies what domain class applies to.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Modeling.RuleOnAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True)> _
Public NotInheritable Class RuleOnAttribute _
    Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)]
public sealed class RuleOnAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true)]
public ref class RuleOnAttribute sealed : public Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)>]
type RuleOnAttribute =  
    class 
        inherit Attribute 
    end
public final class RuleOnAttribute extends Attribute

The RuleOnAttribute type exposes the following members.

Constructors

  Name Description
Public method RuleOnAttribute(String) Initializes a new instance of the RuleOnAttribute class.
Public method RuleOnAttribute(Type) Initializes a new instance of the RuleOnAttribute class.

Top

Properties

  Name Description
Public property AttachDomainType The domain class, relationship, shape, connector or diagram to which this rule applies.
Public property AttachDomainTypeId Gets the ID of the domain type to which this rule applies.
Public property FireTime Gets or sets the time when the rule is executed.
Public property InitiallyDisabled If true, the rule must be explicitly enabled using IsEnabled.
Public property Priority Gets or sets the priority in which the rule is raised.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

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

The type of rule is determined by its base class. For example, AddRule, ChangeRule, DeleteRule.

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