EplanMainThreadDispatcher Class

In This Topic

EplanMainThreadDispatcher can execute some work in the main thread of Eplan.

Inheritance Hierarchy

System.Object
Eplan.EplApi.Base.Internal.EplanMainThreadDispatcher

Syntax

C#
C++/CLI

public class EplanMainThreadDispatcher

public ref class EplanMainThreadDispatcher

Remarks

Executing API code purely of of main Eplan thread is not recommended, i.e. such scenarios were not tested and are out of support. So the class enables executing API code on a main thread from another thread (i.e. like in case of non-modal dialogs or a background worked)

Example

//run an action asynchronously
eplanMainThreadDispatcher.ExecuteInMainThreadAsync(
        () => { new CommandLineInterpreter().Execute("check /TYPE:PROJECT"); }
    );

//create a progress bar with a background work
using (Progress progress = new Progress("SimpleProgress"))
{
    eplanMainThreadDispatcher.AddProgressBackgroundWork(progress,
        () => { new CommandLineInterpreter().Execute("check /TYPE:PROJECT"); }
    );
}

Public Constructors

	Name	Description
	EplanMainThreadDispatcher Constructor	Creates a new dispatcher

Top

Public Methods

	Name	Description
	AddProgressBackgroundWork	Allows the user to add a progress bar when main thread is working.
	CanAccessMainThread	Allows the user to access the main thread both synchronously and asynchronously.
	Dispose	Destructor for deterministic finalization of EplanMainThreadDispatcher object.
	ExecuteInMainThreadAsync	Overloaded. Execute this work in a asynchronous main thread.
	ExecuteInMainThreadSync	Execute this work in a synchronous main thread.
	GetMainThreadDispatcher	Allows to use the dispatcher to work on synchronous and asynchronous threads.

Top

Reference

EplanMainThreadDispatcher Members
Eplan.EplApi.Base.Internal Namespace

Send Feedback