IgnoreAttribute Class

Indicates that a specific test should not be run. This class cannot be inherited.

Namespace:  Microsoft.VisualStudio.TestTools.UnitTesting
Assembly:  Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple := False)> _
Public NotInheritable Class IgnoreAttribute _
    Inherits Attribute
'Usage
Dim instance As IgnoreAttribute
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)]
public sealed class IgnoreAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, AllowMultiple = false)]
public ref class IgnoreAttribute sealed : public Attribute
public final class IgnoreAttribute extends Attribute

Remarks

This should be used to temporarily exclude a specific test when you run a group of tests that contains it. This can be useful for not running a test that is blocking other tests from running because of errors in the code. This is better than commenting out code because the test is still compiled.

This sets the Test Enabled property of the test to false.

This attribute can be specified on a test method or class. There can be only a single instance of this attribute on a method or class.

For more information about how to use attributes, see Extending Metadata Using Attributes.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.TestTools.UnitTesting.IgnoreAttribute

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

IgnoreAttribute Members

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

How to: Disable and Enable Tests