SplashScreenManager.ShowSkinSplashScreen(SvgImage, Nullable<Size>, String, String, String, String, Form, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) Method

Displays a skin-aware splash screen with the specified SVG logo image. The current skin determines the background and font settings splash screen elements.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public static void ShowSkinSplashScreen(
    SvgImage logoImage,
    Size? svgImageSize = null,
    string title = null,
    string subtitle = null,
    string footer = null,
    string loading = null,
    Form parentForm = null,
    bool useFadeIn = true,
    bool useFadeOut = true,
    bool throwExceptionIfAlreadyOpened = true,
    SplashFormStartPosition startPos = SplashFormStartPosition.Default,
    Point location = default(Point)
)

VB.NET

Public Shared Sub ShowSkinSplashScreen(
    logoImage As SvgImage,
    svgImageSize As Size? = Nothing,
    title As String = Nothing,
    subtitle As String = Nothing,
    footer As String = Nothing,
    loading As String = Nothing,
    parentForm As Form = Nothing,
    useFadeIn As Boolean = True,
    useFadeOut As Boolean = True,
    throwExceptionIfAlreadyOpened As Boolean = True,
    startPos As SplashFormStartPosition = SplashFormStartPosition.Default,
    location As Point = Nothing
)

Parameters

Name	Type	Description
logoImage	SvgImage	The logo image in SVG format.

Optional Parameters

Name	Type	Default	Description
svgImageSize	Nullable<Size>	null	The display size of the SVG image.
title	String	null	A string displayed in the title region. If this parameter is not specified (null), the title region displays the value of the AssemblyTitle attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file).
subtitle	String	null	A string displayed in the subtitle region. If this parameter is not specified (null), the subtitle region displays the concatenation of the “Version “ string and the value of the AssemblyFileVersion attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file).
footer	String	null	A string displayed in the footer. If this parameter is not specified (null), the footer displays the concatenation of the AssemblyCopyright attribute value (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file) and the “All Rights Reserved.” string.
loading	String	null	The text displayed above the progress bar.
parentForm	Form	null	The splash screen’s owner.
useFadeIn	Boolean	True	A value that specifies whether to use the fade-in effect when the splash screen is being opened.
useFadeOut	Boolean	True	A value that specifies whether to use the fade-out effect when the splash screen is being closed.
throwExceptionIfAlreadyOpened	Boolean	True	true to throw an exception if another splash form has already been opened; false to suppress this exception.
startPos	SplashFormStartPosition	Default	A value that specifies how the form is positioned.
location	Point	null	Coordinates at which the splash form is shown (if the startPos parameter is set to Manual).

Remarks

C#

using DevExpress.Utils.Svg;
using DevExpress.XtraSplashScreen;

// Logo image.
SvgImage myLogoImage = Resources.Logo;

// Show a splashscreen.
SplashScreenManager.ShowSkinSplashScreen(
    logoImage: myLogoImage,
    svgImageSize: new Size(32, 32),
    title: "When Only The Best Will Do",
    subtitle: "DevExpress WinForms Controls",
    footer: "Copyright © 2000 - 2020 Developer Express Inc." + Environment.NewLine + "All Rights reserved.",
    loading: "Starting...",
    parentForm: this
);


//Do an operation
//...

//Close the splashscreen
DevExpress.XtraSplashScreen.SplashScreenManager.CloseForm();

VB.NET

Imports DevExpress.Utils.Svg
Imports DevExpress.XtraSplashScreen

' Logo image.
Dim myLogoImage As SvgImage = My.Resources.Logo

' Show a splashscreen.
DevExpress.XtraSplashScreen.SplashScreenManager.ShowSkinSplashScreen(
    logoImage:=myLogoImage,
    svgImageSize:=New System.Drawing.Size(32, 32),
    title:="When Only The Best Will Do",
    subtitle:="DevExpress WinForms Controls",
    footer:="Copyright © 2000 - 2020 Developer Express Inc." & Environment.NewLine & "All Rights reserved.",
    loading:="Starting...",
    parentForm:=Me
)

'Do an operation
'...

'Close the splashscreen
DevExpress.XtraSplashScreen.SplashScreenManager.CloseForm()

The following image demonstrates Skin Splash Screen elements you can customize using method parameters.