OpenTAP 9.24
API Reference
Public Member Functions | Properties | List of all members
OpenTap.ITestPlanExport Interface Reference

Custom handler for exporting TestPlan data. Which implementation of ITestPlanExport is used is based on the file type (ITestPlanExport.Extension). More...

Inheritance diagram for OpenTap.ITestPlanExport:
OpenTap.ITapPlugin

Public Member Functions

void ExportTestPlan (TestPlan plan, string filePath)
 Exports the test plan or TestPlan data to a file. More...
 

Properties

string Extension [get]
 The extension of the exported file including the '.'. For example '.zip'.
 
string Name [get]
 Name of the file format. Shown when the user selects the format in the GUI. For example, Compressed Using Zip.
 

Detailed Description

Custom handler for exporting TestPlan data. Which implementation of ITestPlanExport is used is based on the file type (ITestPlanExport.Extension).

The developer determines the content and complexity of classes that implement this type/>. It might be as simple as unzipping a TestPlan, or as complex as reading a well-defined Excel file that represents some TestPlan data.

Member Function Documentation

◆ ExportTestPlan()

void OpenTap.ITestPlanExport.ExportTestPlan ( TestPlan  plan,
string  filePath 
)

Exports the test plan or TestPlan data to a file.

Parameters
planThe plan.
filePathThe absolute or relative path to the file.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:42