WorkItemAttribute Class (Microsoft.VisualStudio.TestTools.UnitTesting)

Switch View :
Classic
Lightweight
ScriptFree
API Reference for Testing Tools for Visual Studio ALM
WorkItemAttribute Class

Used to specify a work item associated with a test.

Inheritance Hierarchy
System.Object
  System.Attribute
    Microsoft.VisualStudio.TestTools.UnitTesting.WorkItemAttribute

Namespace:  Microsoft.VisualStudio.TestTools.UnitTesting
Assembly:  Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)
Syntax
Visual Basic
<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := True)> _
Public NotInheritable Class WorkItemAttribute _
	Inherits Attribute
C#
[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)]
public sealed class WorkItemAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = true)]
public ref class WorkItemAttribute sealed : public Attribute
F#
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)>]
type WorkItemAttribute =  
    class
        inherit Attribute
    end
JScript
public final class WorkItemAttribute extends Attribute

The WorkItemAttribute type exposes the following members.

Constructors
  Name Description
Public method WorkItemAttribute Initializes a new instance of the WorkItemAttribute class with an identification number.
Top
Properties
  Name Description
Public property Id Gets the ID of the work item.
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.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
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.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private 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 implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

This attribute is used to link a test with a work item.

This attribute can be specified on a method. Multiple instances of this attribute may be applied to a method.

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.
See Also

Reference

Microsoft.VisualStudio.TestTools.UnitTesting Namespace
Community Content

Barry_Fandango
How is this used?
I'm using Visual Studio 2010 with TFS 2010.  I fixed a bug and wrote a test to test the bug.  I added the "WorkItem" attribute to my TestMethod with the ID of the bug Work Item. $0$0 $0 $0As far as I can tell It doesn't do anything.  I thought there might be a context menu option to open the work item using Team Explorer, perhaps in the code view or the test results view.  Or maybe the ability from Team Explorer to find test associated with a Work Item.  Is there some functionality that I'm missing out on here?$0