All docs
V20.1
20.2 (EAP/Beta)
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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

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

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

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? ),
    int? startupDelay = default(int? ),
    Size? imageSize = default(Size? ),
    WaitAnimationType? animationType = default(WaitAnimationType? ),
    LineAnimationParams? lineAnimationParameters = default(LineAnimationParams? )
)
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,
    startupDelay As Integer? = Nothing,
    imageSize As Size? = Nothing,
    animationType As WaitAnimationType? = Nothing,
    lineAnimationParameters As LineAnimationParams? = Nothing
) As IOverlaySplashScreenHandle

Parameters

Name Type Description
owner Control

The overlapped control.

Optional Parameters

Name Type Default Description
fadeIn Nullable<Boolean>

null

true, to use the fade-in effect; otherwise, false.

fadeOut Nullable<Boolean>

null

true, to use the fade-out effect; otherwise, false.

backColor Nullable<Color>

null

The background color.

foreColor Nullable<Color>

null

The foreground color.

opacity Nullable<Int32>

null

The transparency level. 0 corresponds to total transparency; 255, to the normal state.

image Image

null

A custom rotating image.

customPainter DevExpress.XtraSplashScreen.IOverlayWindowPainter

null

An object used to paint the form.

skinName String

null

The name of the skin applied to the form.

rotationParameters Nullable<ImageRotationParams>

null

The rotation period and the number of frames in a single rotation.

startupDelay Nullable<Int32>

null

The delay before the form is shown.

imageSize Nullable<Size>

null

The size of the default rotating image.

animationType Nullable<WaitAnimationType>

null

The animation type.

lineAnimationParameters Nullable<LineAnimationParams>

null

The number of dots, their size, and distance between them in a line wait indicator.

Returns

Type Description
DevExpress.XtraSplashScreen.IOverlaySplashScreenHandle

A handle for the shown form. Use this handle to close it.

See Also