SplashScreenManager.ShowImage(Image, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter, Int32) Method

Creates a splash form containing the specified image and displays it after a delay. Allows you to manually position the splash form, disable fade-in and fade-out effects for the image and draw custom graphics over the splash image.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public static void ShowImage(
    Image image,
    bool useFadeIn,
    bool useFadeOut,
    SplashFormStartPosition startPos,
    Point location,
    ICustomImagePainter painter,
    int pendingTime
)

VB.NET

Public Shared Sub ShowImage(
    image As Image,
    useFadeIn As Boolean,
    useFadeOut As Boolean,
    startPos As SplashFormStartPosition,
    location As Point,
    painter As ICustomImagePainter,
    pendingTime As Integer
)

Parameters

Name	Type	Description
image	Image	An Image to be displayed as a splash form.
useFadeIn	Boolean	true to use the fade-in effect when opening the image; otherwise, false.
useFadeOut	Boolean	true, to use the fade-out effect when the image closes; otherwise, false.
startPos	SplashFormStartPosition	The splash form’s arrangement.
location	Point	Coordinates at which the splash form is shown (if the startPos parameter is set to Manual).
painter	DevExpress.XtraSplashScreen.ICustomImagePainter	An ICustomImagePainter object that implements a custom drawing procedure.
pendingTime	Int32	The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed.

Remarks

You can draw custom graphics over the image by using the current ShowImage method and providing an ICustomImagePainter parameter. You need to create a class supporting the ICustomImagePainter interface and implement a paint procedure via the ICustomImagePainter.Draw method. The ICustomImagePainter.Draw method will be invoked each time the splash image is redisplayed. If required, you can dynamically update the splash image by calling the SplashScreenManager.Invalidate method, forcing your ICustomImagePainter.Draw method to be recalled.

See the Splash Image topic for examples.