Class IgnoreAttribute

Marks an assembly, test fixture or test method as being ignored. Ignored tests result in a warning message when the tests are run.

Inheritance
object
Attribute
NUnitAttribute
IgnoreAttribute
Implements
Inherited Members
Namespace: NUnit.Framework
Assembly: nunit.framework.dll
Syntax
[AttributeUsage(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public class IgnoreAttribute : NUnitAttribute, IApplyToTest

Constructors

View Source

IgnoreAttribute(string)

Constructs the attribute giving a reason for ignoring the test.

Declaration
public IgnoreAttribute(string reason)
Parameters
Type Name Description
string reason

The reason for ignoring the test.
Exceptions
Type Condition
ArgumentNullException

If reason is null.

Properties

View Source

Reason

Gets the reason for ignoring the test.

Declaration
public string Reason { get; }
Property Value
Type Description
string
View Source

Until

The date in the future to stop ignoring the test as a string in UTC time. For example for a date and time, "2014-12-25 08:10:00Z" or for just a date, "2014-12-25". If just a date is given, the Ignore will expire at midnight UTC.

Declaration
public string? Until { get; set; }
Property Value
Type Description
string
Remarks

Once the ignore until date has passed, the test will be marked as runnable. Tests with an ignore until date will have an IgnoreUntilDate property set which will appear in the test results.

Exceptions
Type Condition
FormatException

The string does not contain a valid string representation of a date and time.

Methods

View Source

ApplyToTest(Test)

Modifies a test by marking it as Ignored.

Declaration
public void ApplyToTest(Test test)
Parameters
Type Name Description
Test test

The test to modify

Implements