CommunityToolkit.Mvvm8.1 viewmodel源生成器写法(3)

笑嘻嘻的老爸

 
本系列文章导航

• https://www.cnblogs.com/aierong/p/17300066.html
  
• https://github.com/aierong/WpfDemo (自我Demo地址)
  

希望提到的知识对您有所提示,同时欢迎交流和指正
作者:aierong
出处:https://www.cnblogs.com/aierong 
说明

CommunityToolkit.Mvvm8.1最令人惊喜的是它提供的源生成器功能,它极大简化我们的mvvm代码
我们通过标记一个属性就可以实现某个功能,这个很方便快捷,推荐
常用标记总结
1.继承ObservableObject 并且类标记是分部类partial
2.私有变量标记属性 [ObservableProperty]
3.NotifyCanExecuteChangedFor  通知依赖命令
  NotifyPropertyChangedFor    通知依赖属性
4.RelayCommand  定义命令
5.OnPropertyChanged 手动通知属性更新
6.ButtonClickCommand.NotifyCanExecuteChanged() 手动通知命令更新
7.OnLastNameChanging OnLastNameChanged  某个属性改变
8.OnPropertyChanged  所有属性改变
 
定义viewmodel

定义vm时，请使用分部类，并且继承ObservableObject

1. public partial class DataViewModel2 : ObservableObject
2. {
4. }

复制代码

 
ObservableProperty标记属性

定义属性如此简单：一个[ObservableProperty]标记搞定

1. /*
2. [ObservableProperty]标记后,会自动生成属性(大写命名),例如:下面会自动生成Title
4. 注意:这个私有变量命名:必须是小写开头,或者下划线,或者m_
5. */
7. [ObservableProperty]
8. private string title = "hello";
10. //public string Title
11. //{
12. //    get
13. //    {
14. //        return title;
15. //    }
16. //    set
17. //    {
18. //        //title = value;
19. //        //PropertyChanged?.Invoke( this , new PropertyChangedEventArgs( "Name" ) );
21. //        //SetProperty 相当与设置值,并且PropertyChanged通知调用
22. //        SetProperty( ref title , value );
23. //    }
24. //}

复制代码

 
NotifyPropertyChangedFor通知依赖属性

[NotifyPropertyChangedFor( nameof( Caption ) )]标识：在LastName改变后，去通知Caption

1. public string Caption
2. {
3.     get
4.     {
5.         return string.Format( "Title:{0}-{1}" , Title , LastName );
6.     }
7. }
10. [ObservableProperty]
11. [NotifyPropertyChangedFor( nameof( Caption ) )]
12. private string lastName = "abc";

复制代码

 
NotifyCanExecuteChangedFor通知依赖命令

在属性IsEnabled改变后，通知命令：ButtonClickCommand

1. /*
2.         [NotifyCanExecuteChangedFor( nameof( ButtonClickCommand ) )]
3. NotifyCanExecuteChangedFor是通知依赖命令(触发命令),相当于set中ButtonClickCommand.NotifyCanExecuteChanged();
4. */
6. [ObservableProperty]
7. [NotifyCanExecuteChangedFor( nameof( ButtonClickCommand ) )]
8. private bool isEnabled = false;
10. //public bool IsEnabled
11. //{
12. //    get => isEnabled;
13. //    set
14. //    {
15. //        SetProperty( ref isEnabled , value );
17. //        //通知命令 已经改变
18. //        ButtonClickCommand.NotifyCanExecuteChanged();
19. //    }
20. //}
22. //partial void OnIsEnabledChanged ( bool value )
23. //{
24. //     //如果上面的[NotifyCanExecuteChangedFor( nameof( ButtonClickCommand ) )]不写，可以这里手动通知更新
25. //    //ButtonClickCommand.NotifyCanExecuteChanged();
26. //}

复制代码

 
 
命令

RelayCommand标识定义一个命令，如此简单

1. /*
2. RelayCommand是定义命令,自动生成的命令名是方法名+Command,并且初始化
3. 例如:下面的会自动生成ButtonClickCommand
5. CanExecute是指定一个判断方法,判断是否可用
6. */
8. [RelayCommand( CanExecute = nameof( CanButton ) )]
9. void ButtonClick ()
10. {
11.     //点击按钮,修改标题
12.     Title = "hello(改)";
13. }
15. bool CanButton ()
16. {
17.     return IsEnabled;
18. }
20. //public RelayCommand ButtonClickCommand
21. //{
22. //    get;
23. //}
27. [RelayCommand]
28. void ButtonClickPar ( double val )
29. {
30.     Title = $"hello(改):{val}";
31. }
33. //public RelayCommand<double> ButtonClickParCommand
34. //{
35. //    get;
36. //}

复制代码

 
 
异步命令

把方法标识为async，即可定义为异步命令，它带有一个IsRunning属性，可以在view中做进度条判断

1. [RelayCommand]
2. async Task AsyncButtonClick ()
3. {
4.     await Task.Delay( 4800 );
5.     Title = "hello(Task改)";
6. }
10. [RelayCommand]
11. async Task AsyncButtonParClick ( double val )
12. {
13.     await Task.Delay( 4800 );
14.     Title = $"hello(Task改):{val}";
15. }

复制代码

1. [/code] 
2. [size=6]某个属性改变[/size]
4. On+属性Changing  On+属性Changed，可以记录某个属性值变化事件
5. [code]/*
6. 还可以实现2个方法：OnLastNameChanging OnLastNameChanged (注意2个方法只可以实现其中一个,或者都不实现(不能同时2个))
7. */
9. //partial void OnLastNameChanging ( string value )
10. //{
11. //    Debug.WriteLine( value );
12. //}
14. partial void OnLastNameChanged ( string value )
15. {
16.     // 可以做一些其它事情 例如：属性改变后，消息通知某某某
17.     Debug.WriteLine( value );
21.     //说明：如果上面[NotifyPropertyChangedFor( nameof( Caption ) )]不写，可以这里手动通知属性更新
22.     //OnPropertyChanged( nameof( Caption ) );
23. }

复制代码

 
所有属性改变

所有属性改变后都会调用这个事件，参数PropertyName可以区分具体哪个属性

1. /// <summary>
2. /// 所有属性改变
3. /// </summary>
4. /// <param name="e"></param>
5. protected override void OnPropertyChanged ( PropertyChangedEventArgs e )
6. {
8.     base.OnPropertyChanged( e );
10.     // 可以获取到是哪个属性改变了
11.     var _proname = e.PropertyName;
12. }

复制代码

 
完整代码

1. using System;
2. using System.Collections.Generic;
3. using System.ComponentModel;
4. using System.Diagnostics;
5. using System.Linq;
6. using System.Text;
7. using System.Threading.Tasks;
8. using CommunityToolkit.Mvvm.ComponentModel;
9. using CommunityToolkit.Mvvm.Input;
11. /*
12. 这里演示自动生成属性和命令
14. 1.继承ObservableObject 并且类标记是分部类partial
15. 2.私有变量标记属性 [ObservableProperty]
16. 3.NotifyCanExecuteChangedFor  通知依赖命令
17.   NotifyPropertyChangedFor    通知依赖属性
18. 4.RelayCommand  定义命令
19. 5.OnPropertyChanged 手动通知属性更新
20. 6.ButtonClickCommand.NotifyCanExecuteChanged() 手动通知命令更新
21. 7.OnLastNameChanging OnLastNameChanged  某个属性改变
22. 8.OnPropertyChanged  所有属性改变
23. */
25. namespace WpfDemoNet6.Demo
26. {
27.     public partial class DataViewModel2 : ObservableObject
28.     {
29.         /*
30.         [ObservableProperty]标记后,会自动生成属性(大写命名),例如:下面会自动生成Title
32.         注意:这个私有变量命名:必须是小写开头,或者下划线,或者m_
33.         */
35.         /*
36.         NotifyPropertyChangedFor 通知依赖属性Caption
37.         */
39.         [ObservableProperty]
40.         [NotifyPropertyChangedFor( nameof( Caption ) )]
41.         private string title = "hello";
43.         //public string Title
44.         //{
45.         //    get
46.         //    {
47.         //        return title;
48.         //    }
49.         //    set
50.         //    {
51.         //        //title = value;
52.         //        //PropertyChanged?.Invoke( this , new PropertyChangedEventArgs( "Name" ) );
54.         //        //SetProperty 相当与设置值,并且PropertyChanged通知调用
55.         //        SetProperty( ref title , value );
56.         //    }
57.         //}
60.         /*
61.                 [NotifyCanExecuteChangedFor( nameof( ButtonClickCommand ) )]
62.         NotifyCanExecuteChangedFor是通知依赖命令(触发命令),相当于set中ButtonClickCommand.NotifyCanExecuteChanged();
63.         */
65.         [ObservableProperty]
66.         [NotifyCanExecuteChangedFor( nameof( ButtonClickCommand ) )]
67.         private bool isEnabled = false;
69.         //public bool IsEnabled
70.         //{
71.         //    get => isEnabled;
72.         //    set
73.         //    {
74.         //        SetProperty( ref isEnabled , value );
76.         //        //通知命令 已经改变
77.         //        ButtonClickCommand.NotifyCanExecuteChanged();
78.         //    }
79.         //}
81.         //partial void OnIsEnabledChanged ( bool value )
82.         //{
83.         //     //如果上面的[NotifyCanExecuteChangedFor( nameof( ButtonClickCommand ) )]不写，可以这里手动通知更新
84.         //    //ButtonClickCommand.NotifyCanExecuteChanged();
85.         //}
90.         /*
91.         RelayCommand是定义命令,自动生成的命令名是方法名+Command,并且初始化
92.         例如:下面的会自动生成ButtonClickCommand
94.         CanExecute是指定一个判断方法,判断是否可用
95.         */
97.         [RelayCommand( CanExecute = nameof( CanButton ) )]
98.         void ButtonClick ()
99.         {
100.             //点击按钮,修改标题
101.             Title = "hello(改)";
102.         }
104.         bool CanButton ()
105.         {
106.             return IsEnabled;
107.         }
109.         //public RelayCommand ButtonClickCommand
110.         //{
111.         //    get;
112.         //}
116.         public DataViewModel2 ()
117.         {
118.             //RelayCommand的第一个参数是命令调用语句
119.             //              第2个参数(可选)是否允许使用
120.             //ButtonClickCommand = new RelayCommand( () =>
121.             //{
122.             //    //点击按钮,修改标题
123.             //    Title = "hello(改)";
124.             //} , () =>
125.             //{
126.             //    return IsEnabled;
127.             //} );
129.             //ButtonClickParCommand = new RelayCommand<double>( ( double val ) =>
130.             //{
131.             //    Title = $"hello(改):{val}";
132.             //} );
133.         }
137.         [RelayCommand]
138.         void ButtonClickPar ( double val )
139.         {
140.             Title = $"hello(改):{val}";
141.         }
143.         //public RelayCommand<double> ButtonClickParCommand
144.         //{
145.         //    get;
146.         //}
150.         public string Caption
151.         {
152.             get
153.             {
154.                 return string.Format( "Title:{0}-{1}" , Title , LastName );
155.             }
156.         }
159.         [ObservableProperty]
160.         [NotifyPropertyChangedFor( nameof( Caption ) )]
161.         private string lastName = "abc";
163.         /*
164.         还可以实现2个方法：OnLastNameChanging OnLastNameChanged (注意2个方法只可以实现其中一个,或者都不实现(不能同时2个))
165.         */
167.         //partial void OnLastNameChanging ( string value )
168.         //{
169.         //    Debug.WriteLine( value );
170.         //}
172.         partial void OnLastNameChanged ( string value )
173.         {
174.             // 可以做一些其它事情 例如：属性改变后，消息通知某某某
175.             Debug.WriteLine( value );
179.             //说明：如果上面[NotifyPropertyChangedFor( nameof( Caption ) )]不写，可以这里手动通知属性更新
180.             //OnPropertyChanged( nameof( Caption ) );
181.         }
185.         /// <summary>
186.         /// 所有属性改变
187.         /// </summary>
188.         /// <param name="e"></param>
189.         protected override void OnPropertyChanged ( PropertyChangedEventArgs e )
190.         {
192.             base.OnPropertyChanged( e );
194.             // 可以获取到是哪个属性改变了
195.             var _proname = e.PropertyName;
196.         }
198.     }
199. }

复制代码

 
导航https://github.com/aierong/WpfDemo/tree/main/WpfDemoNet6 (项目地址)
https://github.com/aierong/WpfDemo/blob/main/WpfDemoNet6/Demo/DataViewModel2.cs (代码地址)
 
A.Sql Server2005 Transact-SQL 新兵器学习
B.MCAD学习
C.代码阅读总结
D.ASP.NET状态管理
E.DB(数据库)
F.WAP
G.WinForm
H.Flex

希望上面提到的知识对您有所提示,同时欢迎交流和指正
作者:aierong
出处:http://www.cnblogs.com/aierong
贴子以"现状"提供且没有任何担保,同时也没有授予任何权利!
本文版权归作者所有,欢迎转载!
原创技术文章和心得,转载注明出处!这也是对原创者的尊重!


来源:https://www.cnblogs.com/aierong/archive/2023/04/11/17305990.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！