SplashScreenManager.CloseOverlayForm(IOverlaySplashScreenHandle) Method

Closes the Overlay Form with the specified handle.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

public static void CloseOverlayForm(
    IOverlaySplashScreenHandle handle
)
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 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.

See Also