TestAggregation Class

Represents an aggregation of test elements and links.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.Common.TestElement
    Microsoft.VisualStudio.TestTools.Common.TestAggregation

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

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class TestAggregation _
    Inherits TestElement _
    Implements ITestAggregation, ITestElement, ICloneable, IVerifiable,  _
    IVisiblePropertyProvider

[SerializableAttribute]
public abstract class TestAggregation : TestElement, 
    ITestAggregation, ITestElement, ICloneable, IVerifiable, IVisiblePropertyProvider

[SerializableAttribute]
public ref class TestAggregation abstract : public TestElement, 
    ITestAggregation, ITestElement, ICloneable, IVerifiable, IVisiblePropertyProvider

[<AbstractClass>]
[<SerializableAttribute>]
type TestAggregation =  
    class 
        inherit TestElement 
        interface ITestAggregation 
        interface ITestElement 
        interface ICloneable 
        interface IVerifiable 
        interface IVisiblePropertyProvider 
    end

public abstract class TestAggregation extends TestElement implements ITestAggregation, ITestElement, ICloneable, IVerifiable, IVisiblePropertyProvider

The TestAggregation type exposes the following members.

Constructors

	Name	Description
	TestAggregation()	Initializes a new instance of the TestAggregation class.
	TestAggregation(TestAggregation)	Initializes a new instance of the TestAggregation class that is a copy of the provided test aggregation object.
	TestAggregation(SerializationInfo, StreamingContext)	Initializes a new instance of the TestAggregation class from XML by using the provided information and context.
	TestAggregation(String, String)	Initializes a new instance of the TestAggregation class.

Top

Properties

	Name	Description
	AbortRunOnAgentFailure	Gets or sets a value that indicates whether the test run will be aborted if a test agent fails. (Inherited from TestElement.)
	Adapter	When overridden in a derived class, gets the associated diagnostic data adapter. (Inherited from TestElement.)
	AgentAttributes	Gets a dictionary of agent attributes. (Inherited from TestElement.)
	CanBeAggregated	When overridden in a derived class, gets a value that indicates whether this test element can be aggregated. (Inherited from TestElement.)
	CategoryId	Gets or sets the test category ID for this test element. (Inherited from TestElement.)
	ControllerPlugin	When overridden in a derived class, gets a custom controller extension object. (Inherited from TestElement.)
	Copy	Gets a copy of this test element. (Inherited from TestElement.)
	CreatedByUI	Gets or sets a value that indicates whether this element was created by the user interface. (Inherited from TestElement.)
	CssIteration	Gets or sets the iteration path for an associated work item. (Inherited from TestElement.)
	CssProjectStructure	Gets or sets the area path of an associated work item. (Inherited from TestElement.)
	DeploymentItems	Gets a collection of items to be deployed together with this test. (Inherited from TestElement.)
	DeploymentItemsEditable	Gets an array of the file names for those deployment items that are editable. (Inherited from TestElement.)
	Description	Gets or sets a description of this test element. (Inherited from TestElement.)
	Elements	Gets an array of the test element IDs in this aggregation.
	Enabled	Gets or sets a value that indicates whether this test element is enabled. (Inherited from TestElement.)
	ErrorMessageForNonRunnable	Gets the error message to use if the test element is not runnable. (Inherited from TestElement.)
	ExecutionId	Gets or sets the execution ID (Inherited from TestElement.)
	Groups	Gets a collection of property descriptors that represents the groups to which the properties of this test element belong, and also determines how the descriptors will be grouped in the properties window of the user interface. (Inherited from TestElement.)
	HostData	Gets or sets data to be used by the custom host that is identified by the HostType property. (Inherited from TestElement.)
	HostType	Gets or sets the type name for the custom host to use for the test instead of the default host. (Inherited from TestElement.)
	HumanReadableId	Gets the ID of this test element as it appears in the user interface. (Inherited from TestElement.)
	Id	Gets the ID for this test element. (Inherited from TestElement.)
	IsAutomated	Gets a value that indicates whether this test element is automated. (Inherited from TestElement.)
	IsGroupable	Gets or sets a value that indicates whether this test element can be grouped. (Inherited from TestElement.)
	IsLoadTestCandidate	Gets a value that indicates whether this test element will be included in a list of possible load tests in the UI. (Inherited from TestElement.)
	IsModified	Gets or sets a value that indicates whether this test element has been modified. (Inherited from TestElement.)
	IsRunnable	Gets or sets a value that indicates whether this test element is runnable. (Inherited from TestElement.)
	IsRunOnRestart	Gets or sets a value that indicates whether this test element is to be run if the test run is restarted. (Inherited from TestElement.)
	Link	Gets a link to this test element. (Inherited from TestElement.)
	Links	Gets an array of the test links in this aggregation.
	Name	Gets or sets the name of this test element. (Inherited from TestElement.)
	Owner	Gets or sets the name of the owner of this test element. (Inherited from TestElement.)
	ParentExecId	Gets or sets the TestExecId of the parent test element. (Inherited from TestElement.)
	Priority	Gets or sets the relative priority of this test element. (Inherited from TestElement.)
	ProjectData	Gets or sets the data for the test project that contains this test element. (Inherited from TestElement.)
	ProjectName	Gets the name of the test project that contains this test element. (Inherited from TestElement.)
	ProjectRelativePath	Gets the relative path of the test project that contains this test element. (Inherited from TestElement.)
	Properties	Gets a collection of the properties for this test element. (Inherited from TestElement.)
	ReadOnly	When overridden in a derived class, gets or sets a value that indicates whether this test element is read-only. (Inherited from TestElement.)
	SolutionName	Gets the name of the solution that contains this test element. (Inherited from TestElement.)
	SourceFileName	Gets the path and file name for the test that contains this element. (Inherited from TestElement.)
	Storage	Gets or sets the path of the storage location of the deployment items for this element. (Inherited from TestElement.)
	SynchronizedStart	Infrastructure. Obsolete. Gets a value that indicates whether the tests and linked tests in this aggregation must be started synchronously.
	TestCategories	Gets a collection of test category items that is assigned to this test element by the user in the user interface. (Inherited from TestElement.)
	TestIdString	Gets the test ID for this test element as a string. (Inherited from TestElement.)
	TestType	When overridden in a derived class, gets the type of this test. (Inherited from TestElement.)
	TestTypeName	Gets the type of the test element as a string. (Inherited from TestElement.)
	Timeout	Gets or sets the number of seconds before the execution of this test element times out. (Inherited from TestElement.)
	UserData	Gets or sets an object that contains nonpersistable arbitrary data for a custom test element. (Inherited from TestElement.)
	VisibleLinks	Gets an array of links in this test aggregation that is visible in the user interface.
	VisibleProperties	Gets a collection of the properties of this test element that is visible in the user interface. (Inherited from TestElement.)
	WorkItemIds	Gets or sets a list of work item IDs that is associated with this test element. (Inherited from TestElement.)
	WorkItemIdsViewable	Gets or sets a list of work item IDs for viewable work items. (Inherited from TestElement.)

Top

Methods

	Name	Description
	Add	Adds the provided link to the links in this test aggregation.
	AssignIsRunnable	Assigns values for the IsRunnable and ErrorMessageForNonRunnable properties. (Inherited from TestElement.)
	Clear	Removes all links in this test aggregation.
	Clone	When overridden in a derived class, returns a copy of this test element. (Inherited from TestElement.)
	Equals	Returns a value that indicates whether the provided object is equal to this test element object. (Inherited from TestElement.)
	FillDataRow	Fills the provided data row object by using test data results from visible properties of this test element. (Inherited from TestElement.)
	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	Serves as the default hash function. (Inherited from TestElement.)
	GetObjectData	Populates a SerializationInfo by using the data that are required to serialize the target object. (Overrides TestElement.GetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsValid	Returns a value that indicates whether this test element is valid. (Inherited from TestElement.)
	Load	Loads an instance of this class from the provided XML element by using the provided XML store parameters. (Overrides TestElement.Load(XmlElement, XmlTestStoreParameters).)
	MakeLinksRelative	Makes the paths for all links in this test aggregation relative to the provided root path.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the provided link from the links in this test aggregation.
	Save	Saves this object in the provided XML element. (Overrides TestElement.Save(XmlElement, XmlTestStoreParameters).)
	ToString	Returns a string representation of this test element. (Inherited from TestElement.)

Top

Fields

	Name	Description
	m_abortRunOnAgentFailure	Infrastructure. Returns the value of the AbortRunOnAgentFailure property. (Inherited from TestElement.)
	m_agentAttributes	Infrastructure. Returns the value of the AgentAttributes property. (Inherited from TestElement.)
	m_cssIteration	Infrastructure. Returns the value of the CssIteration property. (Inherited from TestElement.)
	m_cssProjectStructure	Infrastructure. Returns the value of the CssProjectStructure property. (Inherited from TestElement.)
	m_deploymentItems	Infrastructure. Returns the value of the DeploymentItems property. (Inherited from TestElement.)
	m_description	Infrastructure. Returns the value of the Description property. (Inherited from TestElement.)
	m_enabled	Infrastructure. Returns the value of the Enabled property. (Inherited from TestElement.)
	m_executionId	Infrastructure. Returns the value of the ExecutionId property. (Inherited from TestElement.)
	m_hostData	Returns the internal host data. (Inherited from TestElement.)
	m_hostType	Infrastructure. Returns the internal value of the HostType. (Inherited from TestElement.)
	m_id	Infrastructure. Returns the value of the Id property. (Inherited from TestElement.)
	m_isGroupable	Infrastructure. Returns the value of the IsGroupable property. (Inherited from TestElement.)
	m_isRunOnRestart	Infrastructure. Returns the value of the IsRunOnRestart property. (Inherited from TestElement.)
	m_links	The internal list of links in this test aggregation.
	m_name	Infrastructure. Returns the value of the Name property. (Inherited from TestElement.)
	m_nonRunnableReason	Infrastructure. Returns the value of the ErrorMessageForNonRunnable property. (Inherited from TestElement.)
	m_owner	Infrastructure. Returns the value of the Owner property. (Inherited from TestElement.)
	m_parentExecutionId	Infrastructure. Returns the value of the ParentExecId property. (Inherited from TestElement.)
	m_priority	Infrastructure. Returns the value of the Priority property. (Inherited from TestElement.)
	m_projectData	Infrastructure. Returns the value of the ProjectData property. (Inherited from TestElement.)
	m_properties	Infrastructure. Returns the value of the Properties property. (Inherited from TestElement.)
	m_storage	Infrastructure. Returns the value of the Storage property. (Inherited from TestElement.)
	m_testCategories	Infrastructure. Returns the value of the TestCategories property. (Inherited from TestElement.)
	m_timeout	Infrastructure. Returns the value of the Timeout property. (Inherited from TestElement.)
	m_userData	Infrastructure. Returns the value of the UserData property. (Inherited from TestElement.)
	m_workItemIds	Infrastructure. Returns the value of the WorkItemIds property. (Inherited from TestElement.)

Top

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.Common Namespace

TestElement

ITestAggregation

ITestElement

IVerifiable

IVisiblePropertyProvider