A Rich Full Featured WPF/SL MVVM Framework

Adding enhancements to the WPF message box service based on Cinch user Michel Renauds comments. In fact Michel provided the work I just reviewed it and added his extra methods.

In his words this is why they needed adding

Early on when we started using Cinch, we noticed some limitations in the message box service, namely hardcoded captions (we sometimes need something more explicit, and the apps are bilingual too) and inability to set a specific button as the default button (e.g. having "Cancel" as the default instead of "Ok" ). I ended up adding more methods to the service to take care of that.

Removed unused Cinch.WPF MediatorSingleton that was npt part of solution but existing on disk. My bad, Cinch.WPF always uses common linked MediatorSingleton file. This does not effect the Dlls just the files on disk, so no harm done here.

1. TabControlEx loaded event
2. Small changes on RestoreFieldValues() methods to protect against null stored values

Fixed a silly mistake where I had changed the StoreValues for DataWrapper base class, but forgot to override RestoreValues(..). This fixes this problem : http://www.codeproject.com/Messages/4008953/EditableValidatingObject-CancelEdit-and-NPC.aspx

Fixing this issue : http://cinch.codeplex.com/discussions/248599

Carrying out request : http://cinch.codeplex.com/discussions/264023

Had to change DataWrapper<T> as the check in for fixing another issue broke something I forgot to change in DataWrapper<T>.IsDirty code. Ooop sorry.

Added the following requested features:
1. Resynced with MefedMVVM version 75221
2. Added GenericRule class
3. Added Validator class
4. Added new ViewModel interface IViewStatusAwareWindowInjectionAware, to allow WPFUIVisualizerService service to inject full IViewAwareStatusWindow into popup ViewModel
5. Added WeakDelegateReference class
6. Altered WPFUIVisualizerService to fix this issue : http://cinch.codeplex.com/discussions/263365
7. Added AsyncHost (WPF Only) (read the comments at top of this file to see example usage)
8. Added CircularProgressBar (WPF Only)
9. Added AsyncFailedUserControl (WPF Only)
10. Added AsyncBusyUserControl (WPF Only)

Forgot to add ICinchDisposable to SVN source control. Grrr…Ooops sorry

1. Modified the WPFOpenFileService/WPFSaveFileService to allow FileName to be set to new value. Previously any set of FileName was ignored. See this Cinch post for details : http://cinch.codeplex.com/workitem/5300
2. Added the ability for the WorkSpaceData classes to be populated with their constructed ViewModel, such that the current ViewModel could be used to create a new ViewModel with the same data.
See these Cinch form posts for details : http://cinch.codeplex.com/Thread/View.aspx?ThreadId=239314 and http://cinch.codeplex.com/Thread/View.aspx?ThreadId=237461 and http://www.codeproject.com/KB/WPF/CinchV2_4.aspx?msg=3685737#xx3685737xx
3. Made the CinchV2.WPFUIVisualizer service use WeakEvents, as there was a potential that the spawning ViewModel could live longer than the popup. I had missed this one, and although I do not think it was a memory leak as such, as it was only using memory while parent VM was around, and that got GC’s when its parent VM was GCd, it was worth fixing, so I fixed it.
4. Made the CinchV2.ChildWindowService unhook from the ViewModelBase. CloseRequest event when the ChildWindow is closing. Which allows the ChildWindow to be GCd
5. One user spotted something silly that I did which was pretty stupid of me, I implemented the IDisposable interface in Cinch.ViewModelBase class. And according to MEF programming guidelines : http://mef.codeplex.com/wikipage?title=Parts%20Lifetime&referringTitle=Guide if your part (and Exported ViewModels are MEF parts) and your part implements IDisposable even if you declare your part with a [PartCreationPolicy(CreationPolicy.NonShared)] MEF will keep the part hanging around, as it expects you to ask the CompositionContainer to release it, by using a call to ReleasePart(..). Now as Meffed is not my code, the solution seemed to be to not use the IDisposable interface. So what I have done is to create a new ICinchDisposable interface which has single Dispose() method, and that is what the CinchV2 ViewModelBase class now uses. I should have spotted that one. Sorry

One user reported DataWrapper<T>.IsDirty was not working in Silverlight even though it was in WPF. The user reported a fix which I have included in SL code branch, I left WPF code alone as it was working just fine. To read more about this you can read this post : http://www.codeproject.com/Messages/3620814/IsDirty-in-a-DataWrapper-bound-to-by-a-checkbox-wi.aspx

Added the following user suggestions
1. Additional IsReadOnly property on DataWrapper<T> which is the inverse value of IsEditable DataWrapper<T> property, but is also a full INPC property. This means that using the DataWrapper<T> with controls that support IsReadOnly, such as TextBox is even easier, and no longer requires a ValueConverter
2. Added in new ParentViewModel property in DataWrapper<T>. Which can be used to perform cross property validation within a DataWrapper<T> rule. For more information on this, see : http://cinch.codeplex.com/Thread/View.aspx?ThreadId=228895
3. Added cleanup method to the IViewAwareStatus/ViewAwareStatus for Silverlight. I would liked to have used WeakReference approach like I did with WPF version, but ran into issue with Silverlight, so opted for a new PerformCleanUp() method that unhooks the FrameworkElements Loaded/Unloaded events (which allows View to be GCd). The best place to call this is in the ViewModel Dispose methods, where you should override the ViewModelBase dispose method. The only tricky bit is figuring out when to call Dispose() on your Disposable ViewModel. The Cinch.SL demos are unable to show this due to the style of demo, but what I would recommend is that if you have some sort of tabbed interface, have a close button on the TabItem which can call Dispose() on your Disposable ViewModel, which will unhook all events for you.

One CinchV2 user spotted a weirdness where design time data was not working with latest version of MefedMVVM (even though I swore I checked it), I talked to this with Marlon and he did make a breaking change by accident, which has now been fixed in MefedMVVM 60612. So I apologize dear users, but this time it was not me, it was him Marlon. Tee Hee. At least it is all good now, all fixed and verified and checked in. Based on this Marlon and I have agreed that every time he updates MefedMVVM we will test it against CinchV2 even if I decide not to resync with MefedMVVM at that stage.
This release also includes a tiny fix for the debugger display string in the WorkSpaceData.ToString() method. My bad ooops

Add a couple of enhancements that users have requested, I was waiting until I got a good list of enhancements together and do them all at once, to minimise the number of downloads. So the following have been done:
• Altered Cinch V1 DataWrapper to take a Action in its constructor such that when the Cinch code generator is used the non auto generated part of the overall ViewModel class will be called back using the Action passed to the constructor of the DataWrapper when a property changes. Also got rid of ridiculous condtructors on the DataWrapper class, and also made it a partial class
• Modified the Cinch code generator to support this, so when you next run the code generator you will see what it did. I basically added another callback call inside of DataWrapper<T> class
• Altered Cinch V2 DataWrapper the same way as I did for V1 above.
• Removed small issue in the WorkspaceData.ToString() override where I did not take into account a possible null dataValue. As you never know what this value could be (it could be any object) I have removed the ToString for the dataValue entirely. This is described at : http://cinch.codeplex.com/workitem/4917
• Made the following classes partial
o ValidatingObject (Cinch v1 and Cinch v2)
o ValidatingViewModelBase (Cinch v1 and Cinch v2)
o ViewModelBase (Cinch v1)
o ValidatingViewModelBase (Cinch v1)
o WorkspaceData (Cinch v2 WPF only)
• Added a new ViewAwareStatusWindow service targeting Windows
• Added a Non mandatory extra event to WorkSpaceData that can be used to cancel a closing of a workspace. Revised WPF demo to show this for ImageLoader workspace and left About workspace as it was to show it is not mandatory.
Resynced with MeffedMVVM release 58837

Had to checkin due to me being a completed and utter SVN imbecile, for which I am incredibly sorry readers. Honest this was last change, and then I realised I forgot to manually add a file to SVN. Grrr. Done now.

Realised that the fix that I checked in to fix WPF build caused a problem with SL demo, which stupidly I did not check. Yes I am an idiot. Anyway the net result is that I had to fix up an issue that was affecting SL demo and Cinch.SL. This is now all done and tested, and I also took the opportunity to resynch Cinch with MeffedMVVM release : 55859, 03/07/2010
I think this will be the last of my changes, I am sorry that there have been a few checkins lately, but there were things that I had to change, sorry about that.

Forgot to add file

One user alerted to me to a possible issue with the way the WPF workspaces work. This led me to look into a possible memory leak area, I talked to Marlon Grech about this, and it turned out to be a problem with way we were both doing StatusAware services. This has now been fixed up with WeakReferences as well as the CommandCompleted event in SimpleCommand<T1,T2> which also caused a strong reference of the View to be maintained. This is all fixed and tested.

Added PartCreationPolicy MEF attributes to ViewModels in WPF/SL demo projects (as it was confusing to some users to always be getting the same ViewModels (although that is ok for the demos, its not very real world like, so showed a more real world scenario, where each View would get a new instance of a ViewModel which is achieved using [PartCreationPolicy(CreationPolicy.NonShared)].

Also to enable this, I have included a specialised TabControl for WPF which allows all open Views to be stored in memory and just shows/hides active one. The standard TabControl in WPF works different to this where is creates entire VisualTree again, so that would be a disaster using MefedMVVM as that would mean we would get a new VM each time we change tabs. So the WPF demo shows you how to work around this using a special TabControlEx which has a code file and Style (AppStyles.xaml) that you can use. See the WPF demo app for that.

As for SL, as the TabControl in SL lacks the correct overrides, I am afraid to say you are on your own in trying to figure out that one.

Adding missing ViewModelBase IsCloseable/DisplayName for compatibility with CinchV1s way of managing workspaces, even though CinchV2 is far far better approach

Fixed problem with CanExecute and WeakReferences and updated demos accordingly

Fixed small design time issue with MainWindowViewModel workspaces

CinchV2 Added ok

Adding CinchV2

Adding CinchV2