TestPropertyAttribute Class
Establishes a test specific property on a method. This class cannot be inherited.
Inheritance Hierarchy
Object
Attribute
Microsoft.VisualStudio.TestTools.UnitTesting.TestPropertyAttribute
Namespace: Microsoft.VisualStudio.TestTools.UnitTesting
Assembly: Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := True)> _
Public NotInheritable Class TestPropertyAttribute _
Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)]
public sealed class TestPropertyAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = true)]
public ref class TestPropertyAttribute sealed : public Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)>]
type TestPropertyAttribute =
class
inherit Attribute
end
public final class TestPropertyAttribute extends Attribute
The TestPropertyAttribute type exposes the following members.
Constructors
Name | Description | |
---|---|---|
TestPropertyAttribute | Initializes a new instance of the TestPropertyAttribute class with values for the Name and Value properties. |
Top
Properties
Name | Description | |
---|---|---|
Name | Gets the name of the test property. | |
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) | |
Value | Gets the value of the test property. |
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 | |
---|---|---|
System#Runtime#InteropServices#_Attribute#GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) | |
System#Runtime#InteropServices#_Attribute#GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) | |
System#Runtime#InteropServices#_Attribute#GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) | |
System#Runtime#InteropServices#_Attribute#Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Top
Remarks
To see a property, first rebuild the project and then highlight the test in the Test List Editor or the Test View window. The property is viewable in the Properties pane after the project is rebuilt.
This attribute can be specified on a test method. There can be multiple instances of this attribute to specify more than one item.
For more information about how to use attributes, see Extending Metadata Using Attributes.
Examples
The following example shows how to access TestProperty properties from within the MyTestMethod() method.
using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Windows.Forms;
using System.Reflection;
namespace TestProperty
{
[TestClass]
public class TestPropertyTest
{
[TestMethod()]
[TestProperty("MyProperty1", "Big")]
[TestProperty("MyProperty2", "Small")]
public void MyTestMethod()
{
// Get the current type
Type t = GetType();
MethodInfo mi = t.GetMethod("MyTestMethod");
Type MyType = typeof(TestPropertyAttribute);
object[] attributes = mi.GetCustomAttributes(MyType, false);
for (int i = 0; i < attributes.Length; i++)
{
string name = ((TestPropertyAttribute)attributes[i]).Name;
string val = ((TestPropertyAttribute)attributes[i]).Value;
string mystring = string.Format("Property Name: {0}, Value: {1}", name, val);
MessageBox.Show(mystring);
}
}
}
}
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
Other Resources
Using Microsoft.VisualStudio.TestTools.UnitTesting Members in Unit Tests