SplashScreenManager.ShowOverlayForm(Control, OverlayWindowOptions) Method

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

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public static IOverlaySplashScreenHandle ShowOverlayForm(
    Control owner,
    OverlayWindowOptions options
)

VB.NET

Public Shared Function ShowOverlayForm(
    owner As Control,
    options As OverlayWindowOptions
) As IOverlaySplashScreenHandle

Parameters

Name	Type	Description
owner	Control	A Control that should be overlapped by an Overlay Form.
options	OverlayWindowOptions	An OverlayWindowOptions object that specifies the Overlay Form options, such as the loading image, fade animation and colors.

Returns

Type	Description
IOverlaySplashScreenHandle	A handle for the shown Overlay Form. Use this handle to close the Overlay Form.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowOverlayForm(Control, OverlayWindowOptions) 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#

integrate-devextreme-javascript-html-editor-into-winforms-app/CS/MainForm.cs#L48

void ShowOverlay() {
    overlayHandle = overlayHandle ?? SplashScreenManager.ShowOverlayForm(layoutControl, options);
}