Running animations in MVVM

We implement Composite application guidance (Prism v2) in our application. Recently we wanted to run animations when something changes in ViewModel. The Viewmodel changes should initiate storyboards or run functions on view.xaml code behind.

I implemented a class ViewModelChangeDispatcher which can be useful to run animations.
You can instantiate this lightweight class from xaml as

view plainprint?

1. <inf:viewmodelchangedispatcher source="{Binding xxxxxAnimation}" <brbr="">OnSourceChangedStartStoryboard="XXXStoryBoard" />  
2. </inf:viewmodelchangedispatcher>  

OnSourceChangedStartStoryboard="XXXStoryBoard" />

The above VMCD is bound to Source xxxAnimation, this when changed will automatically call the storyboard...

If you want to manage multiple animations using the same, u can handle that by this code

view plainprint?

1. <inf:viewmodelchangedispatcher source="{Binding XXXXAnimation}" sourcechanged="RunAnimation">  
2.   
3.   
4. </inf:viewmodelchangedispatcher>  

When source is changed the event handler RunAnimation is called.

Anyway here is how I implemented ViewModelChangeDispatcher.

view plainprint?

1. public class ViewModelChangeDispatcher : FrameworkElement  
2. {  
3. #region Data  
4.   
5. public static readonly DependencyProperty SourceProperty;  
6. public static readonly DependencyProperty OnSourceChangedStartStoryboardProperty;  
7.   
8. // The routed event  
9. public static RoutedEvent SourceChangedEvent;  
10.  
11. #endregion // Data  
12.  
13. #region Static Constructor and static methods  
14.   
15.   
16. static ViewModelChangeDispatcher()  
17. {  
18. SourceProperty = DependencyProperty.Register(  
19. "Source",  
20. typeof(String),  
21. typeof(ViewModelChangeDispatcher),  
22. new FrameworkPropertyMetadata(string.Empty,OnSourcePropertyChanged));  
23.   
24.   
25.   
26. OnSourceChangedStartStoryboardProperty = DependencyProperty.Register(  
27. "OnSourceChangedStartStoryboard",  
28. typeof(Storyboard),  
29. typeof(ViewModelChangeDispatcher));  
30.   
31.   
32. //Registering the events  
33. SourceChangedEvent = EventManager.RegisterRoutedEvent("SourceChanged",  
34. RoutingStrategy.Bubble,  
35. typeof(RoutedEventHandler),  
36. typeof(ViewModelChangeDispatcher));  
37.   
38. }  
39.   
40. private static void OnSourcePropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)  
41. {  
42.   
43. ViewModelChangeDispatcher vmcd = d as ViewModelChangeDispatcher;  
44. if (vmcd == null) return;  
45.   
46. vmcd.RaiseEvent(new RoutedEventArgs(SourceChangedEvent, vmcd));  
47. if (vmcd.OnSourceChangedStartStoryboard == null) return;  
48. vmcd.OnSourceChangedStartStoryboard.Begin();  
49. }  
50.  
51.  
52.  
53. #endregion  
54.  
55. #region constructor and members  
56. public ViewModelChangeDispatcher()  
57. {  
58. this.Visibility = Visibility.Collapsed;  
59. this.Width = 0;  
60. this.Height = 0;  
61.   
62.   
63. }  
64.   
65. /* 
66. * Source is always string. 
67. * It is the onus of the markupextension to convert it to a string. 
68. * 
69. * */  
70. public String Source  
71. {  
72. get { return (String)GetValue(SourceProperty); }  
73. set { SetValue(SourceProperty, value); }  
74. }  
75.   
76.   
77.   
78. public event RoutedEventHandler SourceChanged  
79. {  
80. add { AddHandler(SourceChangedEvent, value); }  
81. remove { RemoveHandler(SourceChangedEvent, value); }  
82. }  
83.   
84. public Storyboard OnSourceChangedStartStoryboard  
85. {  
86. get { return (Storyboard)GetValue(OnSourceChangedStartStoryboardProperty); }  
87. set { SetValue(OnSourceChangedStartStoryboardProperty, value); }  
88. }  
89. #endregion  
90.   
91.   
92. }  

public class ViewModelChangeDispatcher : FrameworkElement
{
#region Data

public static readonly DependencyProperty SourceProperty;
public static readonly DependencyProperty OnSourceChangedStartStoryboardProperty;

// The routed event
public static RoutedEvent SourceChangedEvent;

#endregion // Data

#region Static Constructor and static methods


static ViewModelChangeDispatcher()
{
SourceProperty = DependencyProperty.Register(
"Source",
typeof(String),
typeof(ViewModelChangeDispatcher),
new FrameworkPropertyMetadata(string.Empty,OnSourcePropertyChanged));



OnSourceChangedStartStoryboardProperty = DependencyProperty.Register(
"OnSourceChangedStartStoryboard",
typeof(Storyboard),
typeof(ViewModelChangeDispatcher));


//Registering the events
SourceChangedEvent = EventManager.RegisterRoutedEvent("SourceChanged",
RoutingStrategy.Bubble,
typeof(RoutedEventHandler),
typeof(ViewModelChangeDispatcher));

}

private static void OnSourcePropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{

ViewModelChangeDispatcher vmcd = d as ViewModelChangeDispatcher;
if (vmcd == null) return;

vmcd.RaiseEvent(new RoutedEventArgs(SourceChangedEvent, vmcd));
if (vmcd.OnSourceChangedStartStoryboard == null) return;
vmcd.OnSourceChangedStartStoryboard.Begin();
}



#endregion

#region constructor and members
public ViewModelChangeDispatcher()
{
this.Visibility = Visibility.Collapsed;
this.Width = 0;
this.Height = 0;


}

/*
* Source is always string.
* It is the onus of the markupextension to convert it to a string.
*
* */
public String Source
{
get { return (String)GetValue(SourceProperty); }
set { SetValue(SourceProperty, value); }
}



public event RoutedEventHandler SourceChanged
{
add { AddHandler(SourceChangedEvent, value); }
remove { RemoveHandler(SourceChangedEvent, value); }
}

public Storyboard OnSourceChangedStartStoryboard
{
get { return (Storyboard)GetValue(OnSourceChangedStartStoryboardProperty); }
set { SetValue(OnSourceChangedStartStoryboardProperty, value); }
}
#endregion


}

Please let me know if you have any comments/inputs!

Happy coding!
Pradeep Mahdevu

www.pradeepmahdevu.blogspot.com


Also refer Josh Twist's point of view on this.
joy of code and pavan's post here...

Pixel in genie