Method RequestStop

Namespace

Terminal.Gui.App

Assembly

Terminal.Gui.dll

RequestStop()

Requests that the currently running Session stop. The Session will stop after the current iteration completes.

void RequestStop()

Remarks

This will cause Run(Toplevel, Func<Exception, bool>?) to return.

This is equivalent to calling RequestStop(Toplevel?) with TopRunnable as the parameter.

RequestStop(Toplevel?)

Requests that the currently running Session stop. The Session will stop after the current iteration completes.

void RequestStop(Toplevel? top)

Parameters

top Toplevel

The Toplevel to stop. If null, stops the currently running TopRunnable.

Remarks

This will cause Run(Toplevel, Func<Exception, bool>?) to return.

Calling RequestStop(Toplevel?) is equivalent to setting the Running property on the specified Toplevel to false.

RequestStop(IRunnable?)

Requests that the specified runnable session stop.

void RequestStop(IRunnable? runnable)

Parameters

runnable IRunnable

The runnable to stop. If null, stops the current TopRunnable.

Remarks

This will cause Run(IRunnable, Func<Exception, bool>?) to return.

Raises IsRunningChanging, IsRunningChanged, IsModalChanging, and IsModalChanged events.