Library Class

In This Topic

Main class of the HpD API for the Library application.

Object Model

Inheritance Hierarchy

System.Object
EPLAN.Harness.API.Library

Syntax

public sealed class Library

Remarks

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

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

Example

Initialize the API and use it.

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

//Do something with API

Public Properties

	Name	Description
	ApiCompatibilityVersion	Compatibility version of this HpdApi with version of Harness proD.
	CurrentLibrary	Currently connected library. Null if no library is connected. Only one library can be connected at once.
	HpDVersion	HpD version which is loaded by API.
	LibrarySettings	Harness proD Library application settings.
	RecentLibraries	List of recently connected libraries.
	SkinColors	Harness proD application's skin colors.
	Status	Get state of the Library API. To initialize the API, call Init(String,String[]) Failed API cannot be initialized nor used.

Public Methods

	Name	Description
	AddLibraryConnection	Add an existing connection to a library.
	Close	Close HpD Library API. You should call this when you are done with the HpD Library API. It sets API Status to 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.
	ConnectToLibrary	Overloaded. Connect to library.
	CreateMasterDataLibrary	Overloaded. Create new EPLAN Platform Master Data (SQL Server) library using windows authentication.
	CreateSqlLibrary	Overloaded. Create new MS SQL Server library using windows authentication.
	CreateXmlLibrary	Create new file-system-based library.
	GetInstance	Get instance of HpD Library API.
	Init	Loads HpD and initializes the Library API. Must be called from the Main Thread of an application.
	UpgradeLibrary	Overloaded. Upgrade library specified by the connection to the current version.

Send Feedback