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>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>) Method

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public static IOverlaySplashScreenHandle ShowOverlayForm(
    Control owner,
    bool? fadeIn = null,
    bool? fadeOut = null,
    Color? backColor = null,
    Color? foreColor = null,
    int? opacity = null,
    Image image = null,
    IOverlayWindowPainter customPainter = null,
    string skinName = null,
    ImageRotationParams? rotationParameters = null,
    int? startupDelay = null,
    Size? imageSize = null,
    WaitAnimationType? animationType = null,
    LineAnimationParams? lineAnimationParameters = null,
    bool? useDirectX = null,
    bool? disableInput = null,
    bool? trackOwnerBounds = null
)

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,
    startupDelay As Integer? = Nothing,
    imageSize As Size? = Nothing,
    animationType As WaitAnimationType? = Nothing,
    lineAnimationParameters As LineAnimationParams? = Nothing,
    useDirectX As Boolean? = Nothing,
    disableInput As Boolean? = Nothing,
    trackOwnerBounds As Boolean? = Nothing
) As IOverlaySplashScreenHandle

Parameters

Name	Type
owner	Control

Optional Parameters

Name	Type	Default
fadeIn	Nullable<Boolean>	null
fadeOut	Nullable<Boolean>	null
backColor	Nullable<Color>	null
foreColor	Nullable<Color>	null
opacity	Nullable<Int32>	null
image	Image	null
customPainter	DevExpress.XtraSplashScreen.IOverlayWindowPainter	null
skinName	String	null
rotationParameters	Nullable<ImageRotationParams>	null
startupDelay	Nullable<Int32>	null
imageSize	Nullable<Size>	null
animationType	Nullable<WaitAnimationType>	null
lineAnimationParameters	Nullable<LineAnimationParams>	null
useDirectX	Nullable<Boolean>	null
disableInput	Nullable<Boolean>	null
trackOwnerBounds	Nullable<Boolean>	null

Returns

Type
IOverlaySplashScreenHandle

Related GitHub Examples

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

winforms-overlay-form-display-custom-button/CS/Form1.cs#L42

string taskResult;
IOverlaySplashScreenHandle overlayHandle = SplashScreenManager.ShowOverlayForm(contentPanel, customPainter: new OverlayWindowCompositePainter(overlayLabel, overlayButton));
try {

VB.NET

winforms-overlay-form-display-custom-button/VB/Form1.vb#L45

Dim taskResult As String
Dim overlayHandle As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(contentPanel, customPainter:=New OverlayWindowCompositePainter(overlayLabel, overlayButton))
Try