OpenTAP 9.34
API Reference
OpenTap.IFormatName Interface Reference

A test step implements custom name formatting. More...

Inheritance diagram for OpenTap.IFormatName:
OpenTap.ITestStep OpenTap.ITestStepParent OpenTap.IValidatingObject OpenTap.ITapPlugin

Public Member Functions

string GetFormattedName ()
 Returns the formatted name, this is called before it is given to the logic of TestStep.GetFormattedName, so it include macros ("{}") in the output.
 
- Public Member Functions inherited from OpenTap.ITestStep
void PrePlanRun ()
 Called by TestPlan.Run() for each step in the test plan prior to calling the TestStepBase.Run() methods of each step.
 
void Run ()
 Called by TestPlan.Run() to run each TestStep. If this step has children (ChildTestSteps.Count > 0), then these are executed instead.
 
void PostPlanRun ()
 Called by TestPlan.Run() after completing all TestStepBase.Run() methods in the TestPlan.
 
- Public Member Functions inherited from OpenTap.IValidatingObject
void OnPropertyChanged (string propertyName)
 Triggers the PropertyChanged event.
 

Additional Inherited Members

- Properties inherited from OpenTap.ITestStep
Verdict Verdict [get, set]
 Gets or sets the verdict. Only available during TestStep run. This property value is propagated to the TestStepRun when the step run completes.

 
string Name [get, set]
 Name of the step. Should be set by the user if using multiple instances of the same type.
 
bool Enabled [get, set]
 Gets or sets boolean value that indicates whether this step is enabled in the TestPlan.

 
TestPlanRun PlanRun [get, set]
 Gets or sets the current TestPlanRun.

 
TestStepRun StepRun [get, set]
 Gets or sets the currently running and most recently started TestStepRun.
 
bool IsReadOnly [get, set]
 Gets or sets boolean value that indicates whether this step is read only in the TestPlan.

 
string TypeName [get]
 Name of this TestStep type.

 
Guid Id [get, set]
 Unique ID used for storing references to test steps.

 
- Properties inherited from OpenTap.ITestStepParent
ITestStepParent Parent [get, set]
 Parent TestStep for this TestStep. Null if this TestStep is not a child of any other TestSteps. Only guaranteed to be set during TestPlan.Execute().
 
TestStepList ChildTestSteps [get]
 Gets a list of child TestSteps.
 
- Properties inherited from OpenTap.IValidatingObject
ValidationRuleCollection Rules [get]
 A collection of all the currently defined validation rules. Add new rules here in order to get runtime value validation.
 

Detailed Description

A test step implements custom name formatting.

OpenTAP 9.34 API built Wed Jul 1 2026 09:21:15