Called to create the progress window which will be shown while the optimization is running.

Namespace: RightEdge.Common
Assembly: Common (in Common.dll) Version: 2010.1.0.0 (2010.1.0.0)

Syntax

C#
protected internal virtual Form CreateProgressWindow(
	Action cancelCallback
)
Visual Basic
Protected Friend Overridable Function CreateProgressWindow ( 
	cancelCallback As Action
) As Form
Visual C++
protected public:
virtual Form^ CreateProgressWindow(
	Action^ cancelCallback
)
F#
abstract CreateProgressWindow : 
        cancelCallback : Action -> Form 
override CreateProgressWindow : 
        cancelCallback : Action -> Form 

Parameters

cancelCallback
Type: System..::..Action
A delegate that the progress window should call to cancel the optimization (ie if the user clicks the cancel button).

Return Value

Type: Form
A Form to display progress.

Remarks

You can override this method if you want to use your own optimization progress window. If you don't, the default optimization progress window will be used. The form you return should implement the IOptimizationProgressUpdate interface if you plan to call the UpdateProgress(List<(Of <<'(OptimizationPlugin..::..ProgressItem>)>>)) method at all.

Note that the RunOptimization(SystemRunSettings) method will not be called on the UI thread, so if you want to communicate directly with a custom progress window from that method you will need to marshal the calls onto the UI thread (with the BeginInvoke(Delegate) or Invoke(Delegate) methods).

See Also