SplashScreenManager.CloseOverlayForm(IOverlaySplashScreenHandle) Method

Closes the Overlay Form with the specified handle.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public static void CloseOverlayForm(
    IOverlaySplashScreenHandle handle
)

VB.NET

Public Shared Sub CloseOverlayForm(
    handle As IOverlaySplashScreenHandle
)

Parameters

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

Remarks

The SplashScreenManager.ShowOverlayForm method returns an IOverlaySplashScreenHandle object. Pass this handle to the SplashScreenManager.CloseOverlayForm method to close the opened Overlay Form.

C#

using DevExpress.XtraSplashScreen;
//... 
public partial class ModuleOverlayForm : TutorialControl {

    public ModuleOverlayForm() {
        InitializeComponent();
    }
    //...
    void OnShowClick(object sender, EventArgs e) {
      IOverlaySplashScreenHandle handle = SplashScreenManager.ShowOverlayForm(this.xtraTabPage1);
      Timer timer = new Timer() { Interval = 4000 };
      timer.Tick += (ss, ee) => {
          SplashScreenManager.CloseOverlayForm(handle);
          //You can also use the handle's Close method to close the form.
          //handle.Close();
          timer.Dispose();
      };
      timer.Start();
    }
}

VB.NET

Imports DevExpress.XtraSplashScreen
'...
Partial Public Class ModuleOverlayForm
    Inherits TutorialControl

    Public Sub New()
        InitializeComponent()
    End Sub
    '...
    Private Sub OnShowClick(ByVal sender As Object, ByVal e As EventArgs) Handles btnShow.Click
      Dim handle As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(Me.xtraTabPage1)
      Dim timer As New Timer() With {.Interval = 4000}
      AddHandler timer.Tick, Sub(ss, ee)
        SplashScreenManager.CloseOverlayForm(handle)
        'You can also use the handle's Close method to close the form.
        'handle.Close()
        timer.Dispose()
      End Sub
      timer.Start()
    End Sub
End Class

Note

Run the XtraEditors demo for the complete example.

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#

winforms-overlay-form-display-custom-button/CS/Form1.cs#L47

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

VB.NET

winforms-overlay-form-display-custom-button/VB/Form1.vb#L49

Finally
    SplashScreenManager.CloseOverlayForm(overlayHandle)
    biRunTask.Enabled = True