Back to Devexpress

IOverlaySplashScreenHandle Interface

windowsforms-devexpress-dot-xtrasplashscreen-c540f42f.md

latest3.5 KB
Original Source

IOverlaySplashScreenHandle Interface

A handle for an Overlay Form.

Namespace : DevExpress.XtraSplashScreen

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public interface IOverlaySplashScreenHandle :
    IDisposable
vb
Public Interface IOverlaySplashScreenHandle
    Inherits IDisposable

The following members return IOverlaySplashScreenHandle objects:

LibraryRelated API Members
WinForms ControlsSplashScreenManager.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)
XAF: Cross-Platform .NET App UI & Web APIDXSplashScreen.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.

See Also

IOverlaySplashScreenHandle Members

DevExpress.XtraSplashScreen Namespace