ISharedStep Interface

Represents a reusable collection of test actions.

Namespace:  Microsoft.TeamFoundation.TestManagement.Client
Assembly:  Microsoft.TeamFoundation.TestManagement.Client (in Microsoft.TeamFoundation.TestManagement.Client.dll)

Syntax

'Declaration
Public Interface ISharedStep _
    Inherits ITestBase, ITestObject(Of Integer), IIdentifiable(Of Integer),  _
    IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged, IAttachmentOwner
public interface ISharedStep : ITestBase, 
    ITestObject<int>, IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged, 
    IAttachmentOwner
public interface class ISharedStep : ITestBase, 
    ITestObject<int>, IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged, 
    IAttachmentOwner
type ISharedStep =  
    interface 
        interface ITestBase 
        interface ITestObject<int>
        interface IIdentifiable<int>
        interface IPropertyOwner 
        interface IDataErrorInfo 
        interface INotifyPropertyChanged 
        interface IAttachmentOwner 
    end
public interface ISharedStep extends ITestBase, ITestObject<int>, IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged, IAttachmentOwner

The ISharedStep type exposes the following members.

Properties

  Name Description
Public property ActionRecording Gets or sets the associated action recording.
Public property Actions Gets a collection of test action objects that are stored in the order that they are to be executed. (Inherited from ITestBase.)
Public property Area Gets or sets the classification or functional area to which this test belongs. (Inherited from ITestBase.)
Public property Attachments Gets the collection of attachments. (Inherited from IAttachmentOwner.)
Public property CustomFields Gets a work item tracking collection of user-defined fields that are registered with the server. (Inherited from ITestBase.)
Public property DateCreated Gets the date that this object was created. (Inherited from ITestBase.)
Public property DateModified Gets the date that this object was last modified. (Inherited from ITestBase.)
Public property Description Gets or sets the description of this object. (Inherited from ITestBase.)
Public property Error Gets an error message indicating what is wrong with this object. (Inherited from IDataErrorInfo.)
Public property Exists Gets a value that indicates whether this object has been destroyed and the caller has access to the object. (Inherited from ITestBase.)
Public property Id Gets the identifier. (Inherited from IIdentifiable<TKey>.)
Public property InvalidProperties Gets a list of property names that are invalid. (Inherited from IPropertyOwner.)
Public property IsDirty Gets a value that indicates whether any properties have changed since the last refresh, fetch, or save. (Inherited from IPropertyOwner.)
Public property Item Gets the error message for the property with the given name. (Inherited from IDataErrorInfo.)
Public property Links Gets a work item tracking collection of links to other artifacts. (Inherited from ITestBase.)
Public property Owner Gets or sets the identity of the person who is responsible for this test if it is automated, or the person who is responsible for maintaining the test steps if it is a manual test. (Inherited from ITestBase.)
Public property OwnerName The person responsible for the automation of this test. If the test is manual, the person responsible for maintaining the test steps. (Inherited from ITestBase.)
Public property OwnerTeamFoundationId The person responsible for the automation of this test. If the test is manual, the person responsible for maintaining the test steps. (Inherited from ITestBase.)
Public property Priority Gets or sets the priority for executing this test. (Inherited from ITestBase.)
Public property Project Gets the test project. (Inherited from ITestObject<T>.)
Public property Reason Gets or sets the reason that this object is in its current state. (Inherited from ITestBase.)
Public property Revision Gets the current revision number for this object. (Inherited from ITestObject<T>.)
Public property State Gets or sets the current state of this object. (Inherited from ITestBase.)
Public property TestCaseReferences Gets a list of test cases that contains a reference to this shared step set.
Public property TestParameters Gets a collection of all parameters that are used in the test steps in this test and all parameters that are included in any shared steps. (Inherited from ITestBase.)
Public property Title Gets or sets the title of this test or step. (Inherited from ITestBase.)
Public property UserData Gets or sets an arbitrary object or value that is not persisted, but allows test management objects to be dynamically extended. (Inherited from ITestObject<T>.)
Public property WorkItem Gets the underlying work item. (Inherited from ITestBase.)

Top

Methods

  Name Description
Public method CreateActionRecording Creates an action recording from a file.
Public method CreateAttachment(String) Creates an attachment from a file. (Inherited from IAttachmentOwner.)
Public method CreateAttachment(String, SourceFileAction) Creates an attachment from a file, optionally deleting the source file after uploading. (Inherited from IAttachmentOwner.)
Public method CreateSharedStepReference If this object is a test case, creates a new shared step reference, which gives access to another set of actions. (Inherited from ITestBase.)
Public method CreateTestActionGroup Creates a new test action group, to which steps or other groups may be added. (Inherited from ITestBase.)
Public method CreateTestStep Creates a new test step. (Inherited from ITestBase.)
Public method FindAction Returns the specified action from the Actions property by using the given ID number. (Inherited from ITestBase.)
Public method Flush Brings the work item fields up to date by using the changes that are made in this object. (Inherited from ITestBase.)
Public method OverrideParameter Overrides the specified parameter, which allows for it to be removed from the steps in this specific test case whereas it retains data about the parameter from other iterations. (Inherited from ITestBase.)
Public method Refresh Refreshes the current item from the server and resets the values to those that are stored in the item. Any cached data is discarded. (Inherited from ITestBase.)
Public method RenameParameter Renames a parameter by using the provided parameter name and updates all actions that refer to the referenced parameter. (Inherited from ITestBase.)
Public method ReplaceParameter Finds all instances where the provided parameter is used in actions, deletes any iteration data for each instance, and replaces it by using the provided literal text. (Inherited from ITestBase.)
Public method Save Brings the work item fields up to date by calling the Flush method and then stores each work item to the server. (Inherited from ITestBase.)

Top

Events

  Name Description
Public event AttachmentUploadCompleted This event is raised when the attachment upload is completed. (Inherited from IAttachmentOwner.)
Public event PropertyChanged Occurs when a property value changes. (Inherited from INotifyPropertyChanged.)
Public event TestParameterDeletingEvent The event that is raised when test parameters are about to be deleted. (Inherited from ITestBase.)

Top

See Also

Reference

Microsoft.TeamFoundation.TestManagement.Client Namespace

ITestBase

ITestObject<T>

IPropertyOwner

IDataErrorInfo

INotifyCollectionChanged

IAttachmentOwner