SplashScreenManager.CloseOverlayForm(IOverlaySplashScreenHandle) Method

Closes the Overlay Form with the specified handle.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public static void CloseOverlayForm(
    IOverlaySplashScreenHandle handle
)

VB.NET

Public Shared Sub CloseOverlayForm(
    handle As IOverlaySplashScreenHandle
)

Parameters

Name	Type	Description
handle	DevExpress.XtraSplashScreen.IOverlaySplashScreenHandle	An IOverlaySplashScreenHandle object specifying the handle of the Overlay Form to close.

Remarks

The CloseOverlayForm method closes the Overlay Form with the specified handle. The handle is previously returned by the SplashScreenManager.ShowOverlayForm method.

C#

using DevExpress.XtraSplashScreen;
//...
IOverlaySplashScreenHandle ShowProgressPanel() {
  return SplashScreenManager.ShowOverlayForm(this);
}
void CloseProgressPanel(IOverlaySplashScreenHandle handle) {
  if(handle != null)
    SplashScreenManager.CloseOverlayForm(handle);
}
//...
IOverlaySplashScreenHandle handle = null;
try {
  handle = ShowProgressPanel();
  // Now perform the long-running operation while
  // the Overlay Form overlaps the current form.
}
finally {
  CloseProgressPanel(handle);
}

VB.NET

Imports DevExpress.XtraSplashScreen
'...
Private Function ShowProgressPanel() As IOverlaySplashScreenHandle
    Dim handle As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(Me)
    Return handle
End Function

Private Sub CloseProgressPanel(ByVal handle As IOverlaySplashScreenHandle)
        If handle IsNot Nothing Then SplashScreenManager.CloseOverlayForm(handle)
End Sub
'...
Dim Handle As IOverlaySplashScreenHandle = Nothing
Try
    Handle = ShowProgressPanel()
    'Here you can perform an operation while 
    'the Overlay Form overlaps the main form.
Finally
    CloseProgressPanel(Handle)
End Try

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CloseOverlayForm(IOverlaySplashScreenHandle) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-display-a-custom-button-on-an-overlay-form/CS/Form1.cs#L51

finally {
    SplashScreenManager.CloseOverlayForm(overlayHandle);
    biRunTask.Enabled = true;