DeploymentItemAttribute Class

Article
04/28/2015

Used to specify deployment items such as a file or directory for per-test-deployment. This class cannot be inherited.

Inheritance Hierarchy

Object
Attribute
Microsoft.VisualStudio.TestTools.WebTesting.DeploymentItemAttribute

Namespace: Microsoft.VisualStudio.TestTools.WebTesting
Assembly: Microsoft.VisualStudio.QualityTools.WebTestFramework (in Microsoft.VisualStudio.QualityTools.WebTestFramework.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True)> _
Public NotInheritable Class DeploymentItemAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)]
public sealed class DeploymentItemAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true)]
public ref class DeploymentItemAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)>]
type DeploymentItemAttribute =  
    class 
        inherit Attribute 
    end

public final class DeploymentItemAttribute extends Attribute

The DeploymentItemAttribute type exposes the following members.

Constructors

	Name	Description
	DeploymentItemAttribute(String)	Initializes a new instance of the DeploymentItemAttribute class. Use the path parameter to specify the path to a file or directory to deploy.
	DeploymentItemAttribute(String, String)	Initializes a new instance of the DeploymentItemAttribute class. Use the path parameter to specify the path to a file or directory to deploy, and the outputDirectory parameter to specify the path to the output directory.

Top

Properties

	Name	Description
	OutputDirectory	Gets a value representing the path to the output directory.
	Path	Gets a value that represents the path to the deployment item.
	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.)
	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

Visual Studio 2005 Team Edition for Testers runs tests in a different folder than the folder that holds the built assemblies. When a test is run, the test and code-under-test assemblies, and the deployment items are placed in a test deployment folder unique to that test run. This attribute identifies files and directories that contain files that are used by the deployed test to run. The test engine makes a copy of the deployment items and places them in test deployment directory based upon the OutputDirectory specified or the default directory. See Test Deployment for additional information.

This attribute can be specified on a test class. There can be multiple instances of this attribute to specify more than one item. The item path can be absolute or relative. Relative paths are relative to the RelativePathRoot setting found in the .testrunconfig file.

The following examples demonstrate different usage of the DeploymentItemAttribute:

[DeploymentItem("file1.xml")] Deploys an item named file1.xml located at the RelativeRootPath. The file is deployed to the deployment root directory.
[DeploymentItem("file2.xml", "DataFiles")] Deploys an item named file2.xml located at the RelativeRootPath. The file is deployed to the DataFiles subdirectory of the deployment root directory.
[DeploymentItem("C:\\MyDataFiles\\")] Deploys all items and directories found within the MyDataFiles directory. This does not create the MyDataFiles directory underneath the deployment directory. All files and directories within MyDataFiles will be deployed to the deployment root directory. To copy the entire MyDataFiles directory structure, you must specify MyDataFiles as an output directory.

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.

Partager via