Skip to main content

SplashScreenManager.CloseOverlayForm(IOverlaySplashScreenHandle) Method

Closes the Overlay Form with the specified handle.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

public static void CloseOverlayForm(
    IOverlaySplashScreenHandle handle
)

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.

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();
    }
}

Note

Run the XtraEditors demo for the complete example.

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.

See Also