SplashScreenManager.ShowOverlayForm(Control) Method

Shows an Overlay Form over the specified control with the default options.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public static IOverlaySplashScreenHandle ShowOverlayForm(
    Control owner
)

VB.NET

Public Shared Function ShowOverlayForm(
    owner As Control
) As IOverlaySplashScreenHandle

Parameters

Name	Type	Description
owner	Control	A Control that should be overlapped by an Overlay Form.

Returns

Type	Description
DevExpress.XtraSplashScreen.IOverlaySplashScreenHandle	An IOverlaySplashScreenHandle object that specifies a handle for the shown Overlay Form that is used to close the Overlay Form.

Remarks

Call the ShowOverlayForm method to show an Overlay Form over the owner control using the default options. The ShowOverlayForm method returns an IOverlaySplashScreenHandle object. You should pass this handle to the SplashScreenManager.CloseOverlayForm method to close the opened Overlay Form.

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