Labels: specification

# posted by Sylvain St-Germain @ 3:16 p.m. 13 comments

In some design scenarios launching multiple copies of the same WPF application is a problem, especially for document-based applications or server applications.

WPF does not provide a native solution for single instance applications; however there are several workarounds for this issue.

The most commonly used solution is to check whether another instance of the application is already running when the Application.Startup event fires. This is easily done using a system wide mutex (provided by the operating system to allow interprocess communication). While this is easily done, it limits the developer’s options by not providing a way for the new instance to communicate with the already running instance. Mainly this will provide only a simple way of limiting the number of running instances to one, while a separate system will be required to handle the new calls (usually through remoting or Windows Communication Foundation).

The recommended and more useful approach is to use the built-in support that’s provided in Windows Forms and originally intended for Visual Basic applications. This approach handles the messy plumbing behind the scenes. This means using an old style application class as wrapper for the WPF application. The wrapper will handle the instance management and will communicate the request to the already running instance of the WPF application.

Solution steps:

1) Add a reference to the Microsoft.VisualBasic.dll assembly.

2) Add a new custom class derived from the Microsoft.VisualBasic.ApplicationServices.WindowsFormsApplicationBase class.

3) The IsSingleInstance must be set to true in the constructor. This enables a single instance application.

4) Override the OnStartup() method to create the WPF application object. (Note: The OnStartup() method is triggered when the application starts)

5) Overide the OnStartupNextInstance() method to handle future instances. (Note: The OnStartupNextInstance() method is triggered in when another instance of the application starts up)

6) Define a Main entry point for the application and create the wrapper object

7) Create the WPF application class

Sample of the application wrapper: 

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using Microsoft.VisualBasic.ApplicationServices;

using System.Windows;

namespace SingleInstanceApplication

{

    //The Main entry point class

    public class Startup

    {

        [STAThread]

        public static void Main(string[] args)

        {

            SingleInstanceAppWrapper wrapper = new SingleInstanceAppWrapper();

            wrapper.Run(args);

        }

    }

    //The old-style application wrapper

    public class SingleInstanceAppWrapper : WindowsFormsApplicationBase

    {

        public SingleInstanceAppWrapper()

        {

            // Enable single-instance mode.

            this.IsSingleInstance = true;

        }

        // Create the WPF application class.

        private WPFApplication _app;

        //Override OnStartup() method to create the WPF application object

        protected override bool OnStartup(

             Microsoft.VisualBasic.ApplicationServices.StartupEventArgs e)

        {

            _app = new WPFApplication();

            _app.Run();

            return false;

        }

        // Override OnStartupNextInstance() to handle multiple application instances.

        protected override void OnStartupNextInstance(

             Microsoft.VisualBasic.ApplicationServices.StartupNextInstanceEventArgs e)

        {

            //In case of command line arguments, send them to the WPF application object    

            if (e.CommandLine.Count > 0)

            {

                _app.HandleCommandLine(e.CommandLine);

            }

        }

    }

}

As you can see, the sample above contains the Main entry point for the application. This is required because the wrapper must be created first.
If Visual Studio is used, by default the App.xaml application definition style is used. This will not work with the wrapper because the App.xaml approach already has a Main entry point.
Remove App.xaml and App.xaml.cs from the project and create a new class for the entry point.

The only thing left to do is to create the WPF application definition:

public class WPFApplication : System.Windows.Application

{

    //Override the OnStartup() method

    protected override void OnStartup(System.Windows.StartupEventArgs e)

    {

        base.OnStartup(e);

        //Load the main window

        Window _MainWindow = new Window();

        _MainWindow.Show();

        //Set the MainWindow property for the WPF application object

        this.MainWindow = _MainWindow;

    }

    //Method used to handle command line arguments

    public void HandleCommandLine (System.Collections.ObjectModel.ReadOnlyCollection<string> e)

    {

        //Code to handle command line arguments from other instances goes here

    }

}

Because the wrapper approach does not contain a XAML application definition (App.xaml), if you need to load application level resources, the following code can be placed the OnStartup() of the WPF application definition to load the resources from a resource dictionary:

        Application.Current.Resources.MergedDictionaries.Add(

            Application.LoadComponent(

                new Uri("AssemblyName;component/ApplicationResourceDictionary.xaml",

                UriKind.Relative)) as ResourceDictionary);

The above code will work for dynamic resource definitions. The static resource lookup process will fail because the source for the application resources dictionary need to be specified. In that case the code to load the resources will be replaced with the following:

Application.Current.Resources.Source = 

    new Uri("/AssemblyName;component/ApplicationResourceDictionary.xaml", UriKind.Relative);

Note: AssemblyName is a placeholder for the actual assembly name. The Uri for the resource dictionary location can be changed as required.

Labels: .NET, c#, embedded, Visual Basic, Win32, WPF

# posted by Romeo Dumitrescu @ 11:49 a.m. 18 comments