Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

TestElement Class

 

Provides a base class for all tests.

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

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

[SerializableAttribute]
public ref class TestElement abstract : ITestElement, ICloneable, 
	IVerifiable, IVisiblePropertyProvider, ITestElementResultTestPropertyProvider, 
	IXmlTestStore, IHostedTest

NameDescription
System_CAPS_protmethodTestElement()

Initializes a new instance of the TestElement class.

System_CAPS_protmethodTestElement(SerializationInfo^, StreamingContext)

Initializes a new instance of the TestElement class from serialized data.

System_CAPS_protmethodTestElement(String^, String^)

Initializes a new instance of the TestElement class by using the provided name and description.

System_CAPS_protmethodTestElement(String^, String^, String^)

Initializes a new instance of the TestElement class by using the provided name, description, and storage.

System_CAPS_protmethodTestElement(TestElement^)

Initializes a new instance of the TestElement class by using the provided copy of a test element.

System_CAPS_protmethodTestElement(TestId^, String^, String^)

Initializes a new instance of the TestElement class.

System_CAPS_protmethodTestElement(TestId^, String^, String^, String^)

Initializes a new instance of the TestElement class.

NameDescription
System_CAPS_pubpropertyAbortRunOnAgentFailure

Gets or sets a value that indicates whether the test run will be aborted if a test agent fails.

System_CAPS_pubpropertyAdapter

When overridden in a derived class, gets the associated diagnostic data adapter.

System_CAPS_pubpropertyAgentAttributes

Gets a dictionary of agent attributes.

System_CAPS_pubpropertyCanBeAggregated

When overridden in a derived class, gets a value that indicates whether this test element can be aggregated.

System_CAPS_pubpropertyCategoryId

Gets or sets the test category ID for this test element.

System_CAPS_pubpropertyControllerPlugin

When overridden in a derived class, gets a custom controller extension object.

System_CAPS_pubpropertyCopy

Gets a copy of this test element.

System_CAPS_pubpropertyCreatedByUI

Gets or sets a value that indicates whether this element was created by the user interface.

System_CAPS_pubpropertyCssIteration

Gets or sets the iteration path for an associated work item.

System_CAPS_pubpropertyCssProjectStructure

Gets or sets the area path of an associated work item.

System_CAPS_pubpropertyDeploymentItems

Gets a collection of items to be deployed together with this test.

System_CAPS_pubpropertyDeploymentItemsEditable

Gets an array of the file names for those deployment items that are editable.

System_CAPS_pubpropertyDescription

Gets or sets a description of this test element.

System_CAPS_pubpropertyEnabled

Gets or sets a value that indicates whether this test element is enabled.

System_CAPS_pubpropertyErrorMessageForNonRunnable

Gets the error message to use if the test element is not runnable.

System_CAPS_pubpropertyExecutionId

Gets or sets the execution ID

System_CAPS_pubpropertyGroups

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.

System_CAPS_pubpropertyHostData

Gets or sets data to be used by the custom host that is identified by the HostType property.

System_CAPS_pubpropertyHostType

Gets or sets the type name for the custom host to use for the test instead of the default host.

System_CAPS_pubpropertyHumanReadableId

Gets the ID of this test element as it appears in the user interface.

System_CAPS_pubpropertyId

Gets the ID for this test element.

System_CAPS_pubpropertyIsAutomated

Gets a value that indicates whether this test element is automated.

System_CAPS_pubpropertyIsGroupable

Gets or sets a value that indicates whether this test element can be grouped.

System_CAPS_pubpropertyIsLoadTestCandidate

Gets a value that indicates whether this test element will be included in a list of possible load tests in the UI.

System_CAPS_pubpropertyIsModified

Gets or sets a value that indicates whether this test element has been modified.

System_CAPS_pubpropertyIsRunnable

Gets or sets a value that indicates whether this test element is runnable.

System_CAPS_pubpropertyIsRunOnRestart

Gets or sets a value that indicates whether this test element is to be run if the test run is restarted.

System_CAPS_pubpropertyLink

Gets a link to this test element.

System_CAPS_pubpropertyName

Gets or sets the name of this test element.

System_CAPS_pubpropertyOwner

Gets or sets the name of the owner of this test element.

System_CAPS_pubpropertyParentExecId

Gets or sets the TestExecId of the parent test element.

System_CAPS_pubpropertyPriority

Gets or sets the relative priority of this test element.

System_CAPS_pubpropertyProjectData

Gets or sets the data for the test project that contains this test element.

System_CAPS_pubpropertyProjectName

Gets the name of the test project that contains this test element.

System_CAPS_pubpropertyProjectRelativePath

Gets the relative path of the test project that contains this test element.

System_CAPS_pubpropertyProperties

Gets a collection of the properties for this test element.

System_CAPS_pubpropertyReadOnly

When overridden in a derived class, gets or sets a value that indicates whether this test element is read-only.

System_CAPS_pubpropertySolutionName

Gets the name of the solution that contains this test element.

System_CAPS_pubpropertySourceFileName

Gets the path and file name for the test that contains this element.

System_CAPS_pubpropertyStorage

Gets or sets the path of the storage location of the deployment items for this element.

System_CAPS_pubpropertyTestCategories

Gets a collection of test category items that is assigned to this test element by the user in the user interface.

System_CAPS_pubpropertyTestType

When overridden in a derived class, gets the type of this test.

System_CAPS_pubpropertyTestTypeName

Gets the type of the test element as a string.

System_CAPS_pubpropertyTimeout

Gets or sets the number of seconds before the execution of this test element times out.

System_CAPS_pubpropertyUserData

Gets or sets an object that contains nonpersistable arbitrary data for a custom test element.

System_CAPS_pubpropertyVisibleProperties

Gets a collection of the properties of this test element that is visible in the user interface.

System_CAPS_pubpropertyWorkItemIds

Gets or sets a list of work item IDs that is associated with this test element.

System_CAPS_pubpropertyWorkItemIdsViewable

Gets or sets a list of work item IDs for viewable work items.

NameDescription
System_CAPS_pubmethodAssignIsRunnable(Boolean, String^)

Assigns values for the IsRunnable and ErrorMessageForNonRunnable properties.

System_CAPS_pubmethodClone()

When overridden in a derived class, returns a copy of this test element.

System_CAPS_pubmethodEquals(Object^)

Returns a value that indicates whether the provided object is equal to this test element object.(Overrides Object::Equals(Object^).)

System_CAPS_pubmethodFillDataRow(DataRow^, String^)

Fills the provided data row object by using test data results from visible properties of this test element.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodSystem_CAPS_staticGetDeploymentItemsFromEditableItems(array<String^>^)

Returns a collection of deployment items that is generated from the provided array of the names of those items that are associated with this test that are editable.

System_CAPS_protmethodSystem_CAPS_staticGetEditableItemsFromDeploymentItems(DeploymentItemCollection^)

Returns an array of the names of editable items that is generated from a collection of deployment items.

System_CAPS_pubmethodGetHashCode()
System_CAPS_pubmethodGetObjectData(SerializationInfo^, StreamingContext)

Populates a SerializationInfo by using the data that is required to serialize this object.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsValid()

Returns a value that indicates whether this test element is valid.

System_CAPS_pubmethodLoad(XmlElement^, XmlTestStoreParameters^)

Loads the current object from the provided XML element by using the provided parameters.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSave(XmlElement^, XmlTestStoreParameters^)

Saves the current object to the provided XML element by using the provided parameters.

System_CAPS_pubmethodToString()

Returns a string representation of this test element.(Overrides Object::ToString().)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCanBeAggregatedPropertyName

Returns "CanBeAggregated".

System_CAPS_pubfieldSystem_CAPS_staticCreatedByUIPropertyName

Returns "CreatedByUI".

System_CAPS_pubfieldSystem_CAPS_staticCssIterationPropertyName

Returns "CssIteration".

System_CAPS_pubfieldSystem_CAPS_staticCssProjectStructurePropertyName

Returns "CssProjectStructure".

System_CAPS_pubfieldSystem_CAPS_staticDeploymentItemSeparator

Returns "|".

System_CAPS_pubfieldSystem_CAPS_staticDescriptionPropertyName

Returns "Description".

System_CAPS_pubfieldSystem_CAPS_staticEnabledPropertyName

Returns "Enabled".

System_CAPS_pubfieldSystem_CAPS_staticEnabledPropName

Returns "Enabled".

System_CAPS_pubfieldSystem_CAPS_staticErrorMessageForNonRunnablePropertyName

Returns "ErrorMessageForNonRunnable".

System_CAPS_pubfieldSystem_CAPS_staticHostTypePropertyName

Returns "HostTypePropertyName".

System_CAPS_pubfieldSystem_CAPS_staticHumanReadableIdPropertyName

Returns "HumanReadableId".

System_CAPS_pubfieldSystem_CAPS_staticInfiniteTimeout

Returns the int.MaxValue.

System_CAPS_pubfieldSystem_CAPS_staticIsAutomatedPropertyName

Returns "IsAutomated".

System_CAPS_pubfieldSystem_CAPS_staticIsRunnablePropertyName

Returns "IsRunnable".

System_CAPS_protfieldm_abortRunOnAgentFailure

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the AbortRunOnAgentFailure property.

System_CAPS_protfieldm_agentAttributes

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the AgentAttributes property.

System_CAPS_protfieldm_cssIteration

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the CssIteration property.

System_CAPS_protfieldm_cssProjectStructure

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the CssProjectStructure property.

System_CAPS_protfieldm_deploymentItems

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the DeploymentItems property.

System_CAPS_protfieldm_description

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Description property.

System_CAPS_protfieldm_enabled

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Enabled property.

System_CAPS_protfieldm_executionId

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the ExecutionId property.

System_CAPS_protfieldm_hostData

Returns the internal host data.

System_CAPS_protfieldm_hostType

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the internal value of the HostType.

System_CAPS_protfieldm_id

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Id property.

System_CAPS_protfieldm_isGroupable

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the IsGroupable property.

System_CAPS_protfieldm_isRunOnRestart

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the IsRunOnRestart property.

System_CAPS_protfieldm_name

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Name property.

System_CAPS_protfieldm_nonRunnableReason

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the ErrorMessageForNonRunnable property.

System_CAPS_protfieldm_owner

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Owner property.

System_CAPS_protfieldm_parentExecutionId

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the ParentExecId property.

System_CAPS_protfieldm_priority

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Priority property.

System_CAPS_protfieldm_projectData

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the ProjectData property.

System_CAPS_protfieldm_properties

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Properties property.

System_CAPS_protfieldm_storage

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Storage property.

System_CAPS_protfieldm_testCategories

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the TestCategories property.

System_CAPS_protfieldm_timeout

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the Timeout property.

System_CAPS_protfieldm_userData

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the UserData property.

System_CAPS_protfieldm_workItemIds

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the value of the WorkItemIds property.

System_CAPS_pubfieldSystem_CAPS_staticNamePropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "Name".

System_CAPS_pubfieldSystem_CAPS_staticObjectColumnName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "ObjectColumnName".

System_CAPS_pubfieldSystem_CAPS_staticOwnerPropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "Owner".

System_CAPS_pubfieldSystem_CAPS_staticPriorityPropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "Priority".

System_CAPS_pubfieldSystem_CAPS_staticProjectDataPropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "ProjectData".

System_CAPS_pubfieldSystem_CAPS_staticProjectNamePropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "ProjectName".

System_CAPS_pubfieldSystem_CAPS_staticProjectRelativePathPropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "ProjectRelativePath".

System_CAPS_pubfieldSystem_CAPS_staticSolutionNamePropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "SolutionName".

System_CAPS_pubfieldSystem_CAPS_staticSourceFileNamePropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "SourceFileName".

System_CAPS_pubfieldSystem_CAPS_staticStoragePropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns "Storage".

System_CAPS_pubfieldSystem_CAPS_staticTestCategoryPropertyName

Returns "TestCategory".

System_CAPS_pubfieldSystem_CAPS_staticTestTypePropertyName

Returns "TestType".

System_CAPS_pubfieldSystem_CAPS_staticTimeoutVisiblePropertyName

Returns "TimeoutVisible".

System_CAPS_pubfieldSystem_CAPS_staticWorkItemIdsViewablePropertyName

Returns "WorkItemIdsViewable".

Although some properties are set by using values that a user enters through the user interface, most properties and methods are set, or used, or both, by the internal functionality of the user interface.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: