SplashScreenManager.ShowOverlayForm(Control, Nullable<Boolean>, Nullable<Boolean>, Nullable<Color>, Nullable<Color>, Nullable<Int32>, Image, IOverlayWindowPainter, String, Nullable<ImageRotationParams>) Method

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

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public static IOverlaySplashScreenHandle ShowOverlayForm(
    Control owner,
    bool? fadeIn = default(bool? ),
    bool? fadeOut = default(bool? ),
    Color? backColor = default(Color? ),
    Color? foreColor = default(Color? ),
    int? opacity = default(int? ),
    Image image = null,
    IOverlayWindowPainter customPainter = null,
    string skinName = null,
    ImageRotationParams? rotationParameters = default(ImageRotationParams? )
)

VB.NET

Public Shared Function ShowOverlayForm(
    owner As Control,
    fadeIn As Boolean? = Nothing,
    fadeOut As Boolean? = Nothing,
    backColor As Color? = Nothing,
    foreColor As Color? = Nothing,
    opacity As Integer? = Nothing,
    image As Image = Nothing,
    customPainter As IOverlayWindowPainter = Nothing,
    skinName As String = Nothing,
    rotationParameters As ImageRotationParams? = Nothing
) As IOverlaySplashScreenHandle

Parameters

Name	Type	Description
owner	Control	The control over which the overlay form will be shown.

Optional Parameters

Name	Type	Default	Description
fadeIn	Nullable<Boolean>	*null*	true, if fade-in animation is enabled; otherwise, false.
fadeOut	Nullable<Boolean>	*null*	true, if fade-out animation is enabled; otherwise, false.
backColor	Nullable<Color>	*null*	Overlay form’s background color.
foreColor	Nullable<Color>	*null*	Overlay form’s foreground color.
opacity	Nullable<Int32>	*null*	Overlay form’s transparency level. 0 corresponds to total transparency, 255 - to the normal state.
image	Image	*null*	The “Loading” image shown rotating in the Overlay Form’s center
customPainter	DevExpress.XtraSplashScreen.IOverlayWindowPainter	*null*	An IOverlayWindowPainter object that performs the Overlay Form’s custom draw.
skinName	String	*null*	Overlay form’s skin
rotationParameters	Nullable<DevExpress.XtraSplashScreen.ImageRotationParams>	*null*	Overlay form’s rotation parameters

Returns

Type	Description
DevExpress.XtraSplashScreen.IOverlaySplashScreenHandle	A Control that should be overlapped by an Overlay Form.

Remarks

The below code sample illustrates how to display an overlay form over the window.

C#

IOverlaySplashScreenHandle handle = SplashScreenManager.ShowOverlayForm(this,true,true,Color.Blue,Color.Black,127,Image.FromFile("C:\\image.png"),null,"MyCustomSkin",null);

VB.NET

Dim handle As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(Me,True,True,Color.Blue,Color.Black,127,Image.FromFile("C:\image.png"),Nothing,"MyCustomSkin",Nothing)