HpdApi Class

In This Topic

Main class of the HpD API.

Object Model

Inheritance Hierarchy

System.Object
EPLAN.Harness.API.HpdApi

Syntax

public sealed class HpdApi

Remarks

Use this class as an entry point to the whole API.

This class is a singleton. Use GetInstance to obtain an instance.

Example

Initialize the API and use it.

HpdApi api = HpdApi.GetInstance();
api.Init();

//Do something with API

Public Properties

	Name	Description
	ApiCompatibilityVersion	Compatibility version of this HpdApi with version of Harness proD.
	CurrentProject	Currently opened project. Null if no project is opened. Only one project can be opened at once.
	Status	Get state of the API. To initialize the API, call Init(String,String[]) Failed API cannot be initialized nor used.
	StudioSettings	Harness proD Studio application settings.

Public Methods

	Name	Description
	Close	Close HpD API. You should call this when you are done with the HpD API. It sets API Status to HpdApi.ApiState.Closed. Call Init(String,String[]) to initialize and use the HpD API again. Make sure you have all your documents and project properly saved and closed before this call. When used from plugin, this call has no effect.
	CreateProject	Create a new HpD project.
	CreateProjectFromTemplate	Create a new HpD project from template.
	GetInstance	Get instance of HpD API.
	Init	Loads HpD and initializes the API. Must be called from the Main Thread of an application.
	OpenProject	Open a HpD project.
	ResetAllSettings	Resets all Harness proD Studio settings to the default values.
	RestoreProject	Restore a HpD project.

Send Feedback