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

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

Inheritance diagram for OpenTap.ITestPlanImport:
OpenTap.ITapPlugin

Public Member Functions

TestPlan ImportTestPlan (string filePath)
 Imports a file. The contents of the file can be an entire TestPlan, or data to be inserted into a dynamically created TestPlan.
More...
 

Properties

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

Detailed Description

Custom handler for importing TestPlan data. Which implementation of ITestPlanImport 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

◆ ImportTestPlan()

TestPlan OpenTap.ITestPlanImport.ImportTestPlan ( string  filePath)

Imports a file. The contents of the file can be an entire TestPlan, or data to be inserted into a dynamically created TestPlan.

Parameters
filePathThe absolute or relative path to file.
Returns
The test plan constructed as part of the Import.

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