IOverlaySplashScreenHandle Interface

A handle for an Overlay Form.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

public interface IOverlaySplashScreenHandle :
    IDisposable

VB.NET

Public Interface IOverlaySplashScreenHandle
    Inherits IDisposable

Related API Members

The following members return IOverlaySplashScreenHandle objects:

Library	Related API Members
WinForms Controls	SplashScreenManager.ShowOverlayForm(Control, Nullable<Boolean>, Nullable<Boolean>, Nullable<Color>, Nullable<Color>, Nullable<Int32>, Image, IOverlayWindowPainter, String, Nullable<ImageRotationParams>, Nullable<Int32>, Nullable<Size>, Nullable<WaitAnimationType>, Nullable<LineAnimationParams>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
	SplashScreenManager.ShowOverlayForm(Control, OverlayWindowOptions)
	SplashScreenManager.ShowOverlayForm(Control)
eXpressApp Framework	DXSplashScreen.StartOverlayForm(Control)
	ISupportOverlayForm.StartOverlayForm(Control)
	WinApplication.StartOverlayForm(Control)

Related API Members

The following members return IOverlaySplashScreenHandle objects:

Library	Related API Members
WinForms Controls	SplashScreenManager.ShowOverlayForm(Control, Nullable<Boolean>, Nullable<Boolean>, Nullable<Color>, Nullable<Color>, Nullable<Int32>, Image, IOverlayWindowPainter, String, Nullable<ImageRotationParams>, Nullable<Int32>, Nullable<Size>, Nullable<WaitAnimationType>, Nullable<LineAnimationParams>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
	SplashScreenManager.ShowOverlayForm(Control, OverlayWindowOptions)
	SplashScreenManager.ShowOverlayForm(Control)
eXpressApp Framework	DXSplashScreen.StartOverlayForm(Control)
	ISupportOverlayForm.StartOverlayForm(Control)
	WinApplication.StartOverlayForm(Control)

Remarks

Use the Close() method to close the Overlay Form.

When you display an Overlay Form, the focused control loses focus. When the Overlay Form is closed, this control gets focus back. The QueueFocus(Control) and QueueFocus(IntPtr) methods allow you to specify the control that should be focused when the Overlay Form is closed. Pass IntPtr.Zero to prevent all controls from having focus.

You can also use the QueueCloseUpAction(Action) method to specify the action that should be executed when the Overlay Form is closed.