DeclarativeWebTest Class

  • Article

Represents a declarative, XML-based Web performance test.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.WebTesting.WebTest
    Microsoft.VisualStudio.TestTools.WebTesting.DeclarativeWebTest

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class DeclarativeWebTest _
    Inherits WebTest _
    Implements ICloneable

[SerializableAttribute]
public class DeclarativeWebTest : WebTest, 
    ICloneable

[SerializableAttribute]
public ref class DeclarativeWebTest : public WebTest, 
    ICloneable

[<SerializableAttribute>]
type DeclarativeWebTest =  
    class
        inherit WebTest
        interface ICloneable
    end

public class DeclarativeWebTest extends WebTest implements ICloneable

The DeclarativeWebTest type exposes the following members.

Constructors

  Name Description
Public method DeclarativeWebTest Initializes a new instance of the DeclarativeWebTest class.

Top

Properties

  Name Description
Public property ConditionalRuleReferences Gets a collection of conditional rule references.
Public property Context Gets or sets an object that contains context variables that are available to the Web performance test at run time. (Inherited from WebTest.)
Public property ContextParameters Gets the set of context parameters associated with this Web performance test.
Public property DataSources Gets the collection of data sources that are defined for the Web performance test. (Inherited from WebTest.)
Public property Description Gets or sets a textual description of this Web performance test.
Public property Guid Gets or sets a GUID that uniquely identifies each instance of a WebTest. (Inherited from WebTest.)
Public property InheritFromWebTest Gets the WebTest object for the parent Web performance test when this Web performance test is included in another Web performance test and inherits properties from the parent Web performance test. (Inherited from WebTest.)
Public property Items Gets or sets the set of items that are contained in this Web performance test. Items are transactions, requests, comments, and included Web performance tests.
Public property LastRequestOutcome (Inherited from WebTest.)
Public property LastResponse Gets the last response that was received for a top-level request in this Web performance test. (Inherited from WebTest.)
Public property Name Gets the name of the test case. (Inherited from WebTest.)
Public property Outcome Gets or sets the Pass or Fail outcome of the Web performance test. (Inherited from WebTest.)
Public property Password Gets and sets the password that is used for authentication. (Inherited from WebTest.)
Public property PreAuthenticate Gets or sets a value that indicates whether to pre-authenticate all requests in the Web performance test. (Inherited from WebTest.)
Public property Proxy Gets or sets a value that represents a proxy server for the Web performance test to use. (Inherited from WebTest.)
Public property RequestBodyCaptureLimit Gets or sets the limit, in bytes, that is used to capture request data. (Inherited from WebTest.)
Public property RequestItems Gets a collection of all request items in this test case.
Public property ResponseBodyCaptureLimit Gets or sets the limit, in bytes, that is used to capture response data. (Inherited from WebTest.)
Public property StopOnError Gets or sets the indication of whether the test should stop running when an error occurs. (Inherited from WebTest.)
Public property UserName Gets and sets the user name that is used for authentication. (Inherited from WebTest.)
Public property ValidationRuleReferences Gets the collection of references to Web performance test-level validation rules. (Inherited from WebTest.)
Public property WebProxy Gets or sets the Web proxy for this Web performance test to use. (Inherited from WebTest.)
Public property WebTestPluginReferences Gets the collection of references to Web performance test plug-ins. (Inherited from WebTest.)

Top

Methods

  Name Description
Public method AddCommentToResult Adds a comment to the Web performance test result that follows the most recently completed Web performance test request, transaction, or included Web performance test. (Inherited from WebTest.)
Public method AddDataSource(String, String, DataBindingAccessMethod, array<String[]) Adds a data source to the data collection that is contained by the Web performance test. (Inherited from WebTest.)
Public method AddDataSource(String, String, String, DataBindingAccessMethod, array<String[]) Adds a data source to the data collection that is contained by the Web performance test. (Inherited from WebTest.)
Public method AddDataSource(String, String, String, DataBindingAccessMethod, DataBindingSelectColumns, array<String[]) (Inherited from WebTest.)
Public method AddDataSourceBinding Defines a binding relationship and adds it to the data source binding collection for the Web performance test. (Inherited from WebTest.)
Public method BeginCondition (Inherited from WebTest.)
Public method BeginLoop (Inherited from WebTest.)
Public method BeginTransaction Starts a transaction timer by using the specified name. (Inherited from WebTest.)
Public method Clone Creates a new DeclarativeWebTest that is a copy of the current instance.
Public method EndCondition (Inherited from WebTest.)
Public method EndLoop (Inherited from WebTest.)
Public method EndTransaction(String) Ends a transaction timer with the specified name. (Inherited from WebTest.)
Public method EndTransaction(String, Boolean) Ends the specified transaction. (Inherited from WebTest.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method ExecuteConditionalRule (Inherited from WebTest.)
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 GetDataTableRowCount (Inherited from WebTest.)
Public method GetEnumerator Gets an Enumerator that enumerates the items in the Web performance test. (Inherited from WebTest.)
Public method GetExtractionRuleVariables Returns all the extraction rule variable names in the web test.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetItem Gets the WebTestItem with the specified zero-based request number.
Public method GetRequestEnumerator Gets an enumerator for all requests at run time based on the conditional rule. (Overrides WebTest.GetRequestEnumerator().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IncludeWebTest(String) Calls a coded Web performance test from within a coded Web performance test. (Inherited from WebTest.)
Public method IncludeWebTest(WebTest) Calls a coded Web performance test from within a coded Web performance test. (Inherited from WebTest.)
Public method IncludeWebTest(String, Boolean) Calls a coded Web performance test from within a coded Web performance test. (Inherited from WebTest.)
Public method IncludeWebTest(WebTest, Boolean) Calls a coded Web performance test from within a coded Web performance test. (Inherited from WebTest.)
Public method InitializeDataBinding Adds data source and data binding information from attributes to the current instance. Primarily used for coded web tests. (Overrides WebTest.InitializeDataBinding().)
Public method InsertItemAt Inserts a WebTestItem at the specified item index.
Public method InternalSetOutcome (Inherited from WebTest.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MoveDataTableCursor(String, String) Advances the cursor in the data table to the next record. (Inherited from WebTest.)
Public method MoveDataTableCursor(String, String, Int32) (Inherited from WebTest.)
Public method RegisterDataSourceInLoop (Inherited from WebTest.)
Public method ReloadDataTable (Inherited from WebTest.)
Public method RemoveItemAt Removes the WebTestItem at the specified item index.
Public method Stop Stops the current Web performance test. (Inherited from WebTest.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event PostPage (Inherited from WebTest.)
Public event PostRequest Occurs after each request that this Web performance test runs. (Inherited from WebTest.)
Public event PostTransaction (Inherited from WebTest.)
Public event PostWebTest Occurs after the Web performance test runs. (Inherited from WebTest.)
Public event PrePage (Inherited from WebTest.)
Public event PreRequest Occurs before each request this Web performance test runs. (Inherited from WebTest.)
Public event PreRequestDataBinding (Inherited from WebTest.)
Public event PreTransaction (Inherited from WebTest.)
Public event PreWebTest Occurs before the Web performance test runs. (Inherited from WebTest.)
Public event ValidateResponse Occurs when the response to a Web performance test request has been received and is ready to be validated. (Inherited from WebTest.)
Public event ValidateResponseOnPageComplete (Inherited from WebTest.)

Top

Remarks

Do not use the DeclarativeWebTest class as a base class.

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