IgnoreAttribute Class (Microsoft.VisualStudio.TestTools.UnitTesting)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

API Reference for Testing Tools for Visual Studio ALM

IgnoreAttribute Class

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

Inheritance Hierarchy

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

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

Syntax

Visual Basic

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple := False)> _
Public NotInheritable Class IgnoreAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)]
public sealed class IgnoreAttribute : Attribute

Visual C++

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, AllowMultiple = false)]
public ref class IgnoreAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)>]
type IgnoreAttribute =  
    class
        inherit Attribute
    end

JScript

public final class IgnoreAttribute extends Attribute

The IgnoreAttribute type exposes the following members.

Constructors

	Name	Description
	IgnoreAttribute	Initializes a new instance of the IgnoreAttribute class.

Top

Properties

	Name	Description
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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 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.

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.

Reference

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

How to: Disable and Enable Tests