ValidationStateAttribute Class

Article
11/24/2013

Apply this attribute to a model element class to control whether its instances are included in validation operations. By default, a model element is validated only if validation is explicitly enabled for a class to which it belongs, using this attribute.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.VisualStudio.Modeling.Validation.ValidationStateAttribute

Namespace: Microsoft.VisualStudio.Modeling.Validation
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 ValidationStateAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)]
public sealed class ValidationStateAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true)]
public ref class ValidationStateAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)>]
type ValidationStateAttribute =  
    class 
        inherit Attribute 
    end

public final class ValidationStateAttribute extends Attribute

The ValidationStateAttribute type exposes the following members.

Constructors

	Name	Description
	ValidationStateAttribute	Apply this attribute to a model element class to control whether its instances are included in validation operations.

Top

Properties

	Name	Description
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	ValidationState	Gets the value of ValidationStateAttribute.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

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

Top

Remarks

This attribute enables or disables validation for each domain type.

The values can be:

Enabled
Disabled
Inherited
By default, the validation for a domain type is Inherited. This means that the class will have the same validation behavior as its base class. If there is no explicit base class, the default is Disabled.

Therefore, if you want validation to be applied to model elements, you must explicitly apply this attribute to the domain classes to which they belong.

If you apply the attribute to a base class, you do not need to apply it to derived classes unless you want to exclude them from validation.

For more information, see Validation in a Domain-Specific Language.

Examples

The following example shows the ValidationState attribute applied to the Person class, which enables validation for that class.

[C#]

[ValidationState(ValidationState.Enabled)]
public partial class Person
{
    //Code goes here...
}

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.

Partager via