EplanRemoteClient Class

In This Topic

Eplan Remoting Client used to communicate with an Eplan instance. Note that the binding name should be exactly "EplanRemotingClientBindingConfig" otherwise it will be ignored.

Inheritance Hierarchy

System.Object
   Grpc.Core.ClientBase
      Grpc.Core.ClientBase<T>
            Eplan.EplApi.RemoteClient.EplanRemoteClient

Syntax

C#
C++/CLI

[Guid("25B37226-6821-4493-B585-F805EFBC3146")]
[ComVisible(true)]
public class EplanRemoteClient : Eplan.EplApi.GrpcServer.EplanRemoting.EplanRemotingClient, IEplanRemoteClient

[Guid("25B37226-6821-4493-B585-F805EFBC3146")]
[ComVisible(true)]
public ref class EplanRemoteClient : public Eplan.EplApi.GrpcServer.EplanRemoting::EplanRemotingClient, IEplanRemoteClient

Public Constructors

	Name	Description
	EplanRemoteClient Constructor	Constructor.

Top

Public Fields

	Name	Description
	ResponseArrivedFromEplanServer	Handler to receive Eplan server notifications.

Top

Public Properties

	Name	Description
	Connected
	License	License file name (*.lis).
	Password	Eplan log-in password used for Rights Management.
	SynchronousMode	Sets and gets the Synchronous mode.
	User	Eplan log-in user used for Rights Management. User settings will be used from this user.

Top

Public Methods

	Name	Description
	Connect	Overloaded. Connect to Eplan Server.
	DisableSynchronizingCalls	Overloaded. Disable synchronizing calls. The execution of remote calls are synchronized in EPLAN. A remote call is executed only if the EPLAN Application is in an idle situation and there is no action running. Otherwise the call will wait until the EPLAN application is idle and no action is running. This property can be used to disable this mode. If calls synchronization is disabled, remote calls are executed in EPLAN although the EPLAN application is not in an idle situation.
	Disconnect	Overloaded. Disconnect from Eplan Server.
	DisconnectInternal	Disconnect from Eplan Server.
	Dispose	Dispose.
	ExecuteAction	Overloaded. Execute an action.
	GetActiveEplanServersOnLocalMachine	Get Eplan Servers which are currently active on local machine.
	GetFreePort	Returns first free port which can act as a tunnel for remote server.
	GetInstalledEplanVersionsOnLocalMachine	Get Eplan versions which are currently installed on local machine.
	IsPortFree	Checks if the port is free.
	LockAllEplanObjects	Lock all objects in given project.
	Ping	Overloaded. Ping the Eplan Server.
	SelectEplanObjects	Selects objects in GED
	StartEplan	Overloaded. Starts an Eplan instance.
	StopEplan	Stops the Eplan instance which is connected to the current client.
	UnlockAllEplanObjects	Unlock all objects in given project.
	WithHost	(Inherited from Grpc.Core.ClientBase<EplanRemoting.EplanRemotingClient>)

Top

Reference

EplanRemoteClient Members
Eplan.EplApi.RemoteClient Namespace

Use the Eplan Global Support Portal for feedback and support