Caliburn Micro Conductor Stackoverflow Question

.gitignore

obj/
Bin/
Properties/
Tests/

README.md

OnActivate and OnDeactivate confusion.

App.xaml

<Application xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
             x:Class="DelmeStackOverflow.App"
             >
    <Application.Resources>
        
    </Application.Resources>
</Application>

App.xaml.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.Silverlight.Testing;
using Microsoft.Silverlight.Testing.Client;
using Microsoft.Silverlight.Testing.Harness;

namespace DelmeStackOverflow
{
    public partial class App : Application
    {

        public App()
        {
            this.Startup += this.Application_Startup;
            this.Exit += this.Application_Exit;
            this.UnhandledException += this.Application_UnhandledException;

            InitializeComponent();
        }

        private void Application_Startup(object sender, StartupEventArgs e)
        {
            //this.RootVisual = new MainPage();
            UnitTestSettings settings = UnitTestSystem.CreateDefaultSettings();
            settings.StartRunImmediately = true;
            settings.ShowTagExpressionEditor = false;
            settings.TestHarness = new UnitTestHarness();

            this.RootVisual = UnitTestSystem.CreateTestPage(settings);
        }

        private void Application_Exit(object sender, EventArgs e)
        {

        }

        private void Application_UnhandledException(object sender, ApplicationUnhandledExceptionEventArgs e)
        {
            // If the app is running outside of the debugger then report the exception using
            // the browser's exception mechanism. On IE this will display it a yellow alert 
            // icon in the status bar and Firefox will display a script error.
            if (!System.Diagnostics.Debugger.IsAttached)
            {

                // NOTE: This will allow the application to continue running after an exception has been thrown
                // but not handled. 
                // For production applications this error handling should be replaced with something that will 
                // report the error to the website and stop the application.
                e.Handled = true;
                Deployment.Current.Dispatcher.BeginInvoke(delegate { ReportErrorToDOM(e); });
            }
        }

        private void ReportErrorToDOM(ApplicationUnhandledExceptionEventArgs e)
        {
            try
            {
                string errorMsg = e.ExceptionObject.Message + e.ExceptionObject.StackTrace;
                errorMsg = errorMsg.Replace('"', '\'').Replace("\r\n", @"\n");

                System.Windows.Browser.HtmlPage.Window.Eval("throw new Error(\"Unhandled Error in Silverlight Application " + errorMsg + "\");");
            }
            catch (Exception)
            {
            }
        }
    }
}

AppManifest.xml

<Deployment xmlns="http://schemas.microsoft.com/client/2007/deployment"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
>
    <Deployment.Parts>
    </Deployment.Parts>
</Deployment>

AssemblyInfo.cs

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

// General Information about an assembly is controlled through the following 
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("DelmeStackOverflow")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("DelmeStackOverflow")]
[assembly: AssemblyCopyright("Copyright ©  2014")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

// Setting ComVisible to false makes the types in this assembly not visible 
// to COM components.  If you need to access a type in this assembly from 
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]

// The following GUID is for the ID of the typelib if this project is exposed to COM
[assembly: Guid("7298b53d-6a16-4fd8-859d-fa07721cf4d9")]

// Version information for an assembly consists of the following four values:
//
//      Major Version
//      Minor Version 
//      Build Number
//      Revision
//
// You can specify all the values or you can default the Revision and Build Numbers 
// by using the '*' as shown below:
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]

CaliburnMicroConductorDemo.csproj

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
    <ProductVersion>8.0.50727</ProductVersion>
    <SchemaVersion>2.0</SchemaVersion>
    <ProjectGuid>{7298B53D-6A16-4FD8-859D-FA07721CF4D9}</ProjectGuid>
    <ProjectTypeGuids>{A1591282-1198-4647-A2B1-27E5FF5F6F3B};{fae04ec0-301f-11d3-bf4b-00c04f79efbc}</ProjectTypeGuids>
    <OutputType>Library</OutputType>
    <AppDesignerFolder>Properties</AppDesignerFolder>
    <RootNamespace>DelmeStackOverflow</RootNamespace>
    <AssemblyName>DelmeStackOverflow</AssemblyName>
    <TargetFrameworkIdentifier>Silverlight</TargetFrameworkIdentifier>
    <TargetFrameworkVersion>v5.0</TargetFrameworkVersion>
    <SilverlightVersion>$(TargetFrameworkVersion)</SilverlightVersion>
    <SilverlightApplication>true</SilverlightApplication>
    <SupportedCultures>
    </SupportedCultures>
    <XapOutputs>true</XapOutputs>
    <GenerateSilverlightManifest>true</GenerateSilverlightManifest>
    <XapFilename>DelmeStackOverflow.xap</XapFilename>
    <SilverlightManifestTemplate>AppManifest.xml</SilverlightManifestTemplate>
    <SilverlightAppEntry>DelmeStackOverflow.App</SilverlightAppEntry>
    <TestPageFileName>DelmeStackOverflowTestPage.html</TestPageFileName>
    <CreateTestPage>true</CreateTestPage>
    <ValidateXaml>true</ValidateXaml>
    <EnableOutOfBrowser>false</EnableOutOfBrowser>
    <OutOfBrowserSettingsFile>Properties\OutOfBrowserSettings.xml</OutOfBrowserSettingsFile>
    <UsePlatformExtensions>false</UsePlatformExtensions>
    <ThrowErrorsInValidation>true</ThrowErrorsInValidation>
    <LinkedServerProject>
    </LinkedServerProject>
  </PropertyGroup>
  <!-- This property group is only here to support building this project using the 
       MSBuild 3.5 toolset. In order to work correctly with this older toolset, it needs 
       to set the TargetFrameworkVersion to v3.5 -->
  <PropertyGroup Condition="'$(MSBuildToolsVersion)' == '3.5'">
    <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
    <DebugSymbols>true</DebugSymbols>
    <DebugType>full</DebugType>
    <Optimize>false</Optimize>
    <OutputPath>Bin\Debug</OutputPath>
    <DefineConstants>DEBUG;TRACE;SILVERLIGHT</DefineConstants>
    <NoStdLib>true</NoStdLib>
    <NoConfig>true</NoConfig>
    <ErrorReport>prompt</ErrorReport>
    <WarningLevel>4</WarningLevel>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
    <DebugType>pdbonly</DebugType>
    <Optimize>true</Optimize>
    <OutputPath>Bin\Release</OutputPath>
    <DefineConstants>TRACE;SILVERLIGHT</DefineConstants>
    <NoStdLib>true</NoStdLib>
    <NoConfig>true</NoConfig>
    <ErrorReport>prompt</ErrorReport>
    <WarningLevel>4</WarningLevel>
  </PropertyGroup>
  <ItemGroup>
    <Reference Include="Caliburn.Micro, Version=1.5.2.0, Culture=neutral, PublicKeyToken=8e5891231f2ed21f, processorArchitecture=MSIL">
      <SpecificVersion>False</SpecificVersion>
      <HintPath>..\..\Caliburn.Micro\bin\Silverlight\Release\Caliburn.Micro.dll</HintPath>
    </Reference>
    <Reference Include="Microsoft.Silverlight.Testing">
      <HintPath>..\..\..\..\..\Program Files (x86)\Microsoft SDKs\Silverlight\v5.0\Toolkit\dec11\Testing\Microsoft.Silverlight.Testing.dll</HintPath>
    </Reference>
    <Reference Include="Microsoft.VisualStudio.QualityTools.UnitTesting.Silverlight">
      <HintPath>..\..\..\..\..\Program Files (x86)\Microsoft SDKs\Silverlight\v5.0\Toolkit\dec11\Testing\Microsoft.VisualStudio.QualityTools.UnitTesting.Silverlight.dll</HintPath>
    </Reference>
    <Reference Include="mscorlib" />
    <Reference Include="System.Windows" />
    <Reference Include="system" />
    <Reference Include="System.Core">
      <HintPath>$(TargetFrameworkDirectory)System.Core.dll</HintPath>
    </Reference>
    <Reference Include="System.Net" />
    <Reference Include="System.Xml" />
    <Reference Include="System.Windows.Browser" />
  </ItemGroup>
  <ItemGroup>
    <Compile Include="App.xaml.cs">
      <DependentUpon>App.xaml</DependentUpon>
    </Compile>
    <Compile Include="MainPage.xaml.cs">
      <DependentUpon>MainPage.xaml</DependentUpon>
    </Compile>
    <Compile Include="AssemblyInfo.cs" />
    <Compile Include="TestHarness.cs" />
    <Compile Include="ViewModelFactory.cs" />
    <Compile Include="DialogResult.cs" />
    <Compile Include="DockableViewModel.cs" />
    <Compile Include="DocumentViewModel.cs" />
    <Compile Include="DocViewerViewModel.cs" />
    <Compile Include="IDockManager.cs" />
    <Compile Include="IViewModelFactory.cs" />
    <Compile Include="NoDataViewModel.cs" />
    <Compile Include="ProjectExplorerViewModel.cs" />
    <Compile Include="SaveDialogViewModel.cs" />
    <Compile Include="ToolViewerViewModel.cs" />
  </ItemGroup>
  <ItemGroup>
    <ApplicationDefinition Include="App.xaml">
      <SubType>Designer</SubType>
      <Generator>MSBuild:Compile</Generator>
    </ApplicationDefinition>
    <Page Include="MainPage.xaml">
      <SubType>Designer</SubType>
      <Generator>MSBuild:Compile</Generator>
    </Page>
  </ItemGroup>
  <ItemGroup>
    <None Include="Properties\AppManifest.xml" />
  </ItemGroup>
  <ItemGroup>
    <Folder Include="Tests\" />
    <Folder Include="ViewModels\" />
    <Folder Include="Views\" />
  </ItemGroup>
  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\Silverlight\$(SilverlightVersion)\Microsoft.Silverlight.CSharp.targets" />
  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
       Other similar extension points exist, see Microsoft.Common.targets.
  <Target Name="BeforeBuild">
  </Target>
  <Target Name="AfterBuild">
  </Target>
  -->
  <ProjectExtensions>
    <VisualStudio>
      <FlavorProperties GUID="{A1591282-1198-4647-A2B1-27E5FF5F6F3B}">
        <SilverlightProjectProperties />
      </FlavorProperties>
    </VisualStudio>
  </ProjectExtensions>
</Project>

CaliburnMicroConductorDemo.csproj.user

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <ProjectExtensions>
    <VisualStudio>
      <FlavorProperties GUID="{A1591282-1198-4647-A2B1-27E5FF5F6F3B}">
        <SilverlightProjectProperties>
          <StartPageUrl>
          </StartPageUrl>
          <StartAction>DynamicPage</StartAction>
          <AspNetDebugging>True</AspNetDebugging>
          <NativeDebugging>False</NativeDebugging>
          <SQLDebugging>False</SQLDebugging>
          <ExternalProgram>
          </ExternalProgram>
          <StartExternalURL>
          </StartExternalURL>
          <StartCmdLineArguments>
          </StartCmdLineArguments>
          <StartWorkingDirectory>
          </StartWorkingDirectory>
          <ShowWebRefOnDebugPrompt>True</ShowWebRefOnDebugPrompt>
          <OutOfBrowserProjectToDebug>
          </OutOfBrowserProjectToDebug>
          <ShowRiaSvcsOnDebugPrompt>True</ShowRiaSvcsOnDebugPrompt>
        </SilverlightProjectProperties>
      </FlavorProperties>
    </VisualStudio>
  </ProjectExtensions>
</Project>

DialogResult.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace DelmeStackOverflow.ViewModels
{
    public enum DialogResult
    {
        Cancel,
        Yes
    }
}

DockableViewModel.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Caliburn.Micro;

namespace DelmeStackOverflow.ViewModels
{
    public class DockableViewModel: Screen
    {
    }
}

DocumentViewModel.cs

using System;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Caliburn.Micro;

namespace DelmeStackOverflow.ViewModels
{
    public abstract class DocumentViewModel : Screen
    {
        private bool _isDirty;

        protected IViewModelFactory ViewModelFactory { get; private set; }
        protected IEventAggregator EventAggregator { get; private set; }

        public bool IsDirty
        {
            get
            {
                return _isDirty;
            }
            protected set
            {
                if (value.Equals(_isDirty))
                {
                    return;
                }
                _isDirty = value;
                NotifyOfPropertyChange(() => IsDirty);
            }
        }

        protected DocumentViewModel(IViewModelFactory viewModelFactory, IEventAggregator eventAggregator)
        {
            ViewModelFactory = viewModelFactory;
            EventAggregator = eventAggregator;
        }

        protected override void OnDeactivate(bool close)
        {
            if (close)
            {
                if (EventAggregator != null)
                {
                    EventAggregator.Unsubscribe(this);
                }
            }
            base.OnDeactivate(close);
        }

        protected override void OnActivate()
        {
            if (EventAggregator != null)
            {
                EventAggregator.Subscribe(this);
            }
            base.OnActivate();
        }

        public override void CanClose(Action<bool> callback)
        {
            var ret = true;
            if (IsDirty && (ViewModelFactory != null))
            {
                var saveDialog = ViewModelFactory.Create<SaveDialogViewModel>();
                saveDialog.Show();
                if (saveDialog.DialogResult == DialogResult.Cancel)
                {
                    ret = false;
                }
                else
                {
                    if (saveDialog.DialogResult == DialogResult.Yes)
                    {
                        Save();
                    }
                    else
                    {
                        Discard();
                    }
                    IsDirty = false;
                }
            }
            callback(ret);
        }

        public abstract void Save();

        public virtual void Discard()
        {
        }

    }
}

DocViewerViewModel.cs

using System;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Caliburn.Micro;

namespace DelmeStackOverflow.ViewModels
{
    public class DocViewerViewModel : Conductor<DocumentViewModel>
    {
        private readonly IViewModelFactory _viewModelFactory;

        public DocViewerViewModel(IViewModelFactory viewModelFactory)
        {
            _viewModelFactory = viewModelFactory;
        }

        public bool ShowInMainView<T>() where T : DocumentViewModel
        {
            return ShowInMainView(typeof(T));
        }

        private bool ShowInMainView(Type viewModelType)
        {
            var ret = false;

            // close the current view
            if (ActiveItem != null)
            {
                DeactivateItem(ActiveItem, true); //The close flag is on true since we want to remove the current instance from the memory
            }

            // check whether the current viewModel has been closed successfully
            if (ActiveItem == null)
            {
                try
                {
                    var viewModel = _viewModelFactory.Create(viewModelType) as DocumentViewModel;
                    if (viewModel != null)
                    {
                        ActivateItem(viewModel);
                        ret = true;
                    }
                    else
                    {
                        ActivateItem(_viewModelFactory.Create<NoDataViewModel>());
                    }
                }
                catch (Exception ex)
                {
                    ActivateItem(_viewModelFactory.Create<NoDataViewModel>());
                }
            }

            return ret;
        }

        int _countActivated = 0;
        public int CountActivated()
        {
            return _countActivated;
        }

        int _countDeactivated = 0;
        public int CountDeactivated()
        {
            return _countDeactivated;
        }

        public override void ActivateItem(DocumentViewModel item)
        {
            _countActivated++;
            base.ActivateItem(item);
        }

        public override void DeactivateItem(DocumentViewModel item, bool close)
        {
            _countDeactivated++;
            base.DeactivateItem(item, close);
        }
    }
}

IDockManager.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace DelmeStackOverflow.ViewModels
{
    public class IDockManager
    {
        internal void Link(ToolViewerViewModel toolViewerViewModel)
        {
            throw new NotImplementedException();
        }

        internal void CreateSpecialPaneFor(DocViewerViewModel _docViewerViewModel)
        {
            throw new NotImplementedException();
        }
    }
}

IViewModelFactory.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Caliburn.Micro;

namespace DelmeStackOverflow.ViewModels
{
    public interface IViewModelFactory
    {
        T1 Create<T1>() where T1: Screen;

        DocumentViewModel Create(Type viewModelType);
    }
}

MainPage.xaml

<UserControl x:Class="DelmeStackOverflow.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    mc:Ignorable="d"
    d:DesignHeight="300" d:DesignWidth="400">

    <Grid x:Name="LayoutRoot" Background="White">

    </Grid>
</UserControl>

MainPage.xaml.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;

namespace DelmeStackOverflow
{
    public partial class MainPage : UserControl
    {
        public MainPage()
        {
            InitializeComponent();
        }
    }
}

NoDataViewModel.cs

using System;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Caliburn.Micro;

namespace DelmeStackOverflow.ViewModels
{
    public class NoDataViewModel: DocumentViewModel
    {
        public NoDataViewModel(): base(null, null)
        {
        }

        public override void Save()
        {
            
        }
    }
}

ProjectExplorerViewModel.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace DelmeStackOverflow.ViewModels
{
    class ProjectExplorerViewModel : DockableViewModel
    {
    }
}

SaveDialogViewModel.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Caliburn.Micro;

namespace DelmeStackOverflow.ViewModels
{
    public class SaveDialogViewModel: Screen
    {
        internal void Show()
        {
            throw new NotImplementedException();
        }

        public DialogResult DialogResult { get; set; }
    }
}

TestHarness.cs

using System;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Caliburn.Micro;
using DelmeStackOverflow.ViewModels;
using Microsoft.Silverlight.Testing;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace DelmeStackOverflow.Tests
{
    [TestClass]
    public class TestHarness: SilverlightTest
    {
        [TestMethod]
        public void CheckDeactivation()
        {
            // We'd like to have the ToolViewerViewModel only Conduct the dock-able views 
            // and the DocViewerViewModel to conduct the DocumentViewModel.

            IViewModelFactory factory = new ViewModelFactory();
            DocViewerViewModel docViewer = new DocViewerViewModel(factory);
            IDockManager dockManager = null;

            var toolViewer = new ToolViewerViewModel(factory, docViewer, dockManager);
            var mockToolView = new UserControl();           
            (toolViewer as IViewAware).AttachView(mockToolView);

            DocumentViewModel docView1 = new NoDataViewModel();
            DocumentViewModel docView2 = new NoDataViewModel();
            docViewer.ActivateItem(docView1);
            docViewer.ActivateItem(docView2);

            Assert.AreEqual(0, docViewer.CountDeactivated());
        }

    }
}

ToolViewerViewModel.cs

using System;
using System.Collections.Generic;
using Caliburn.Micro;
namespace DelmeStackOverflow.ViewModels
{
    public class ToolViewerViewModel : Conductor<Screen>.Collection.OneActive
    {
        private readonly IDockManager _dockManager;
        private readonly DocViewerViewModel _docViewerViewModel;
        private readonly IList<DockableViewModel> _toolViews = new List<DockableViewModel>();
        private readonly IViewModelFactory _viewModelFactory;

        public ToolViewerViewModel(IViewModelFactory viewModelFactory, DocViewerViewModel docViewerViewModel, IDockManager dockManager)
        {
            _dockManager = dockManager;
            _viewModelFactory = viewModelFactory;
            _docViewerViewModel = docViewerViewModel;
        }

        protected override void OnViewLoaded(object view)
        {
            // CGT
            if (_dockManager != null)
            {
                _dockManager.Link(this);
                _dockManager.CreateSpecialPaneFor(_docViewerViewModel);
            }
            ActivateItem(_docViewerViewModel);

            ShowToolView<ProjectExplorerViewModel>();
            base.OnViewLoaded(view);
        }

        public void ShowToolView<T>() where T : DockableViewModel
        {
            if (!IsToolViewOpen<T>())
            {
                var viewModel = _viewModelFactory.Create<T>();
                ActivateItem(viewModel);
                RefreshMenu(typeof(T));
                _isToolViewOpen = true;
            }
        }

        /* ------------------ EXTRAS -------------------------- */
         
        private void RefreshMenu(Type type)
        {
            
        }

        bool _isToolViewOpen = false;
        private bool IsToolViewOpen<T1>()
        {
            return _isToolViewOpen;
        }
    }

}

ViewModelFactory.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Caliburn.Micro;
using DelmeStackOverflow.ViewModels;

namespace DelmeStackOverflow.Tests
{
    internal class ViewModelFactory : IViewModelFactory
    {
        public DocumentViewModel Create(Type viewModelType)
        {
            throw new NotImplementedException();
        }


        public T1 Create<T1>() where T1 : Screen
        {
            return System.Activator.CreateInstance<T1>();
        }
    }
}