Click here to Skip to main content
11,718,589 members (86,476 online)
Click here to Skip to main content

Implement Splash Screen with WPF

, 23 Jul 2009 CPOL 145.6K 14K 111
Rate this:
Please Sign up or sign in to vote.
Show a custom splash screen with loading messages

Introduction

Now almost all applications have a splash screen. This screen will be shown when the application starts, after the main window of the application is shown, this screen will be closed.

Demo effect, the application is loading modules.

Background

WPF has provided an easy way to implement splash screen. Using this way, we should add an image as resource to the project, and set its BuildAction property to “SplashScreen”. This feature is only supported on .NET Framework 3.5. When the application starts, the image will be shown at first as the splash screen. I know this way is implemented via WinForm technology.

The above method is easy, but it is too simple and doesn’t meet my requirements. My requirements of splash screen are:

  • The way of show the screen is reusable, thus each application I made can use the same way to show a splash screen
  • The splash screen is easy to customize, thus each application I made can have different splash screens and I can make it as beautiful as I can
  • The splash screen can show messages to the user, for example show the loading progress of the application
  • The splash screen may not be a regular shape, it may be a circle and other not rectangle shape, but this is not necessary and important to me

Normally a splash screen has the below features:

  • The splash screen doesn’t show in the task bar
  • The splash screen is always shown at the center of the screen
  • The splash screen doesn’t have window title bar and border, it is not resizable

My Design

To meet the above requirements, my design is as below:

  • App

    App class inherits from Application class and provides the application entry.
    When entering the Main method, initialize the splash screen and show it by calling the Splasher class, and then run the application, show the main window.

    /// <summary>
        /// 
        /// </summary>
        class App: Application
        {
            /// <summary>
            /// 
            /// </summary>
            [STAThread ( )]
            static void Main ( )
            {
                Splasher.Splash = new SplashScreen ( );
                Splasher.ShowSplash ( ); 
    
                // Simulate application loading
                for ( int i = 0; i < 5000; i++ )
                {
                    MessageListener.Instance.ReceiveMessage 
    			( string.Format ( "Load module {0}", i ) );
                    Thread.Sleep ( 1 );
                } 
                new App ( );
            }
             /// <summary>
            /// 
            /// </summary>
            public App ( )
            {         
                StartupUri = new System.Uri ( "MainWindow.xaml", UriKind.Relative ); 
                Run ( );            
            }
        } 
  • MainWindow

    Application’s main window, it’s just a normal window.

  • SplashScreen

    Splash screen window, it’s just a normal window, this window has the special features that a splash screen should have. I have mentioned it above.

  • Splasher

    A helper class to show and close splash screen window, the splash screen window should be initialized by the application. With this class, I don't care which window is the splash screen, and it’s reusable.

    /// <summary>
    /// Helper to show or close given splash window
    /// </summary>
    public static class Splasher
    {
        /// <summary>
        /// 
        /// </summary>
        private static Window mSplash; 
        /// <summary>
        /// Get or set the splash screen window
        /// </summary>
        public static Window Splash
        {
            get
            {
                return mSplash;
            }
            set
            {
                mSplash = value;
            }
        } 
        /// <summary>
        /// Show splash screen
        /// </summary>
        public static void ShowSplash ( )
        {
            if ( mSplash != null )
            {
                mSplash.Show ( );
            }
        }
        /// <summary>
        /// Close splash screen
        /// </summary>
        public static void CloseSplash ( )
        {
            if ( mSplash != null )
            {
                mSplash.Close ( ); 
                if ( mSplash is IDisposable )
                    ( mSplash as IDisposable ).Dispose ( );
            }
        }
    } 
  • DispatcherHelper

    This is a helper class, implement DoEvents method like System.Windows.Forms.Application’s DoEvents method, if there is no such function, the loading message of the splash will not be refreshed correctly. The code is shown below:

    /// <summary>
    /// Simulate Application.DoEvents function of 
    /// <see cref=" System.Windows.Forms.Application"/> class.
    /// </summary>
    [SecurityPermissionAttribute ( SecurityAction.Demand, 
    	Flags = SecurityPermissionFlag.UnmanagedCode )]
    public static void DoEvents ( )
    {
        DispatcherFrame frame = new DispatcherFrame ( );
        Dispatcher.CurrentDispatcher.BeginInvoke ( DispatcherPriority.Background,
                    new DispatcherOperationCallback ( ExitFrames ), frame ); 
        try
        {
            Dispatcher.PushFrame ( frame );
        }
        catch ( InvalidOperationException )
        {
        }
    } 
  • MessageListener

    This class inherit from DependencyObject, WPF’s UI element can easily bind to its property and update correctly. This class just receives a string message. To show the loading progress message in the splash screen, I add a TextBlock element to the window, and bind its Text property to listener’s Message property, and when the application is loading, I write messages to the listener.

Final Effect

The final splash screen looks like below. I define the window with a WPF window, the Label at the bottom of the window shows the loading tip messages (progress) of the application.

A very simple main window.

History

  • Version 1.0 2009.07.20

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Andy Lang
Architect
China China
No Biography provided

You may also be interested in...

Comments and Discussions

 
Questionhow to start form1 Pin
Member 105381831-Feb-14 19:15
memberMember 105381831-Feb-14 19:15 
QuestionHow to bind modules? Pin
prachur22-Nov-13 3:09
memberprachur22-Nov-13 3:09 
GeneralVery helpful - thanks! Pin
Member 100520284-Nov-13 10:18
memberMember 100520284-Nov-13 10:18 
GeneralMy vote of 4 Pin
Sergey Orlov22-Nov-12 0:30
memberSergey Orlov22-Nov-12 0:30 
QuestionAbout splash screen design Pin
avisal21-Sep-12 10:38
memberavisal21-Sep-12 10:38 
GeneralMy vote of 4 Pin
NirdeshSaini15-Mar-12 4:44
memberNirdeshSaini15-Mar-12 4:44 
GeneralMy vote of 1 Pin
crusjiber31-Jan-12 23:50
membercrusjiber31-Jan-12 23:50 
GeneralMy vote of 1 Pin
Paul3221-Jan-12 2:55
memberPaul3221-Jan-12 2:55 
GeneralMy vote of 1 Pin
ian oakes2-Jun-11 18:43
memberian oakes2-Jun-11 18:43 
Inherited a project using this, and it's crap.
Questiononly running at c#? Pin
yardloun9-Apr-11 2:57
memberyardloun9-Apr-11 2:57 
GeneralMy vote of 2 Pin
42882-Jan-11 8:31
member42882-Jan-11 8:31 
GeneralSplach screen - how it should be done ... Pin
kadukf18-May-10 2:59
memberkadukf18-May-10 2:59 
QuestionRe: Splach screen - how it should be done ... Pin
prophetpp15-Aug-11 1:53
memberprophetpp15-Aug-11 1:53 
GeneralNot the best solution IMO Pin
Saragani214-Apr-10 3:48
memberSaragani214-Apr-10 3:48 
GeneralRe: Not the best solution IMO Pin
Andy Lang14-Apr-10 4:28
memberAndy Lang14-Apr-10 4:28 
GeneralRe: Not the best solution IMO Pin
kreutpet9-Aug-11 5:24
memberkreutpet9-Aug-11 5:24 
Generalunload splash Pin
peug11-Jan-10 23:02
memberpeug11-Jan-10 23:02 
GeneralRe: unload splash Pin
Andy Lang12-Jan-10 3:17
memberAndy Lang12-Jan-10 3:17 
GeneralRe: unload splash Pin
Member 378897922-Jul-10 22:41
memberMember 378897922-Jul-10 22:41 
GeneralThis doesn't work in VB.NET Pin
dexter743-Nov-09 2:54
memberdexter743-Nov-09 2:54 
GeneralRe: This doesn't work in VB.NET Pin
Andy Lang3-Nov-09 3:14
memberAndy Lang3-Nov-09 3:14 
GeneralRe: This doesn't work in VB.NET [modified] Pin
dexter743-Nov-09 3:40
memberdexter743-Nov-09 3:40 
GeneralRe: This doesn't work in VB.NET Pin
Ruard18-Nov-09 9:25
memberRuard18-Nov-09 9:25 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150901.1 | Last Updated 23 Jul 2009
Article Copyright 2009 by Andy Lang
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid