Winform 實(shí)現(xiàn)進(jìn)度條彈窗和任務(wù)控制
最近要給一個(gè) Winform 項(xiàng)目添加功能,需要一個(gè)能顯示進(jìn)度條的彈窗,還要求能夠中止任務(wù),所以就做了一個(gè),在此做個(gè)記錄總結(jié)。雖然用的是比較老的 Winform 技術(shù),不過(guò)其中的原理都是相通的。
一、彈窗前臺(tái)
首先提供一個(gè) Winform 控件居中的小技巧:
將控件放在 TableLayoutPanel 容器中,然后將控件的 Anchor 屬性設(shè)置為 None,這樣控件就能在容器中居中了:
將容器的 Anchor 屬性設(shè)置為 Top, Left, Right,這樣容器就能隨著窗口左右拉伸了:
最終彈窗界面如下:
使用了 CSkin 界面庫(kù)(v16.1.14.3),(注意:如果拖拽 dll 到工具箱拖不了,可以使用右鍵復(fù)制粘貼的方式),窗體繼承 Skin_DevExpress,進(jìn)度條使用 SkinProgressBar,按鈕使用 SkinButton,主要是使用了一些圓角效果:
二、彈窗后臺(tái)
先添加兩個(gè)事件供外界訂閱,分別為窗體載入時(shí)觸發(fā)的執(zhí)行操作事件,和點(diǎn)擊中止按鈕后觸發(fā)的終止操作事件:
/// <summary> /// 執(zhí)行操作事件 /// </summary> public event Action OperateAction; /// <summary> /// 終止操作事件 /// </summary> public event Action AbortAction; /// <summary> /// 中止按鈕點(diǎn)擊事件 /// </summary> private void btn_Abort_Click(object sender, EventArgs e) { AbortAction?.Invoke(); DialogResult = DialogResult.Abort; //Close(); //不需要手動(dòng)關(guān)閉; } /// <summary> /// 窗體載入事件 /// </summary> private void FormProgressDialog_Load(object sender, EventArgs e) { Task.Factory.StartNew(() => { OperateAction?.Invoke(); DialogResult = DialogResult.OK; }); }
點(diǎn)擊中止按鈕后還將彈窗結(jié)果設(shè)為 Abort,會(huì)自動(dòng)關(guān)閉彈窗;而業(yè)務(wù)操作正常執(zhí)行完畢,彈窗結(jié)果為 OK。
供外界設(shè)置文本信息以及進(jìn)度條進(jìn)度的方法如下:
/// <summary> /// 設(shè)置顯示信息(值為null時(shí)保持不變) /// </summary> /// <param name="rtfTitleContent">富文本格式的標(biāo)題內(nèi)容</param> /// <param name="totalMessage">總體消息</param> /// <param name="currentMessage">當(dāng)前消息</param> public void SetInfo(string rtfTitleContent = null, string totalMessage = null, string currentMessage = null) { if (rtfTitleContent != null) rtb_Title.Rtf = rtfTitleContent; if (totalMessage != null) lbl_Total.Text = totalMessage; if (currentMessage != null) lbl_Current.Text = currentMessage; } /// <summary> /// 設(shè)置進(jìn)度 /// </summary> /// <param name="currentValue">當(dāng)前數(shù)值</param> /// <param name="totalValue">總數(shù)值</param> public void SetProsess(double currentValue, double totalValue) { try { progressBar.Value = (int)(currentValue / totalValue * 100); } catch (Exception ex) { Console.WriteLine(ex); } }
剩下就是兩個(gè)設(shè)置富文本框 RichTextBox 的方法,包括設(shè)置彩色內(nèi)容和隱藏 RichTextBox 光標(biāo)的方法,文末會(huì)給出代碼地址,此處不再贅述。
三、使用方法
首先映入眼簾的是兩個(gè)成員變量,一個(gè)是用于任務(wù)取消的 CancellationTokenSource 對(duì)象,另一個(gè)是用于線(xiàn)程同步的 AutoResetEvent 對(duì)象(用于取消任務(wù)后的一些信息同步);然后是主測(cè)試方法(一個(gè)按鈕點(diǎn)擊事件方法)中的一些信息設(shè)置:
然后設(shè)置 CancellationTokenSource 對(duì)象的 Token,給它注冊(cè)一個(gè)取消任務(wù)時(shí)調(diào)用的委托方法,里面先等待同步信號(hào)結(jié)果再進(jìn)行本次執(zhí)行結(jié)果的判斷:
接下來(lái)訂閱彈窗中的那兩個(gè)事件,在執(zhí)行操作事件中開(kāi)啟任務(wù),并傳遞 Token;在中止事件中停止任務(wù):
需要注意的是,停止任務(wù)后,任務(wù)內(nèi)部并不會(huì)自己停止,需要判斷 Token 的 IsCancellationRequested 字段來(lái)決定相應(yīng)的操作,比如結(jié)束循環(huán)。然后,因?yàn)樵谥白?cè)的取消的委托方法中,進(jìn)行了等待,所以我們?cè)趫?zhí)行完業(yè)務(wù)方法(BusinessMethod)并設(shè)置好相關(guān)狀態(tài)值后,需要判斷任務(wù)是否取消,如果取消,說(shuō)明注冊(cè)的取消的委托方法中已經(jīng)在等待了,所以要調(diào)用 Set () 進(jìn)行放行。
有人可能就會(huì)問(wèn)了,foreach 循環(huán)開(kāi)始時(shí)不是判斷過(guò)是否取消了嗎?這里怎么又判斷?這是因?yàn)?,比如在一輪循環(huán)中,已經(jīng)執(zhí)行過(guò)了開(kāi)頭的是否已取消的判斷(IsCancellationRequested 為 false),開(kāi)始執(zhí)行耗時(shí)的業(yè)務(wù)方法了,此時(shí)用戶(hù)點(diǎn)擊中止按鈕,IsCancellationRequested 被置為 true,所以業(yè)務(wù)方法執(zhí)行后再次判斷會(huì)得到最新的狀態(tài),然后,循環(huán)將在下一輪開(kāi)始時(shí)結(jié)束。
另外,由于實(shí)際使用這個(gè)的項(xiàng)目是 .NET 4.0 框架,所以 Task 的一些方法沒(méi)有,大家用新框架的話(huà)可以使用新方法。或者使用 Microsoft.Bcl.Async 包,然后使用 TaskEx。
繼續(xù)流程,接下來(lái)以模態(tài)框方式彈出窗口,并獲取結(jié)果。業(yè)務(wù)處理方法中模擬了耗時(shí)操作并返回是否成功。
最后給出完整代碼:
#region 測(cè)試任務(wù)進(jìn)度條彈窗 private CancellationTokenSource _Cts; //任務(wù)取消令牌; private AutoResetEvent _AutoResetEvent = new AutoResetEvent(false);//參數(shù)傳 false,則 WaitOne 時(shí)阻塞等待; /// <summary> /// 測(cè)試任務(wù)進(jìn)度彈窗 /// </summary> private void BtnProgressDialog_Click(object sender, EventArgs e) { _AutoResetEvent.Reset(); string businessName = "業(yè)務(wù)1"; FormProgressDialog progressWindow = new FormProgressDialog() { Text = "任務(wù)處理窗口", }; progressWindow.SetColorfulTitle("業(yè)務(wù)1 ", Color.DarkOrange, true); progressWindow.SetColorfulTitle("正在執(zhí)行中......", Color.Black); progressWindow.SetInfo(null, "", ""); List<string> orders = new List<string>(){"訂單1", "訂單2", "訂單3", "訂單4", "訂單5" }; //業(yè)務(wù)數(shù)據(jù); List<string> leftList = orders.Select(x => x).ToList(); //剩余(未處理)數(shù)據(jù); int successCount = 0; //成功數(shù)量; _Cts = new CancellationTokenSource(); //注冊(cè)一個(gè)將在取消此 CancellationToken 時(shí)調(diào)用的委托; _Cts.Token.Register(async () => { ShowInfo("操作終止"); await Task.Run(() => { _AutoResetEvent.WaitOne(1000 * 5); //等待有可能還在執(zhí)行的業(yè)務(wù)方法; if (successCount < orders.Count) { ShowInfo($"{businessName} 有 {orders.Count - successCount} 項(xiàng)任務(wù)被終止,可在消息框中查看具體項(xiàng)。"); foreach (var leftName in leftList) { ShowInfo($"【{businessName}】的【{leftName}】執(zhí)行失敗,失敗原因:【手動(dòng)終止】。"); } } }); }); progressWindow.OperateAction += () => { Task task = new Task(() => { foreach (var order in orders) { //判斷是否被取消; if (_Cts.Token.IsCancellationRequested) { break; } progressWindow.TryBeginInvoke(new Action(() => { progressWindow.SetInfo(null, $"共{orders.Count}項(xiàng),已執(zhí)行{successCount}項(xiàng)", $"當(dāng)前正在執(zhí)行:{order}"); })); if (BusinessMethod(order, businessName)) { successCount++; leftList.RemoveAll(x => x == order); if (_Cts.Token.IsCancellationRequested) { _AutoResetEvent.Set(); //放行 Register 委托處的等待; } } progressWindow.TryBeginInvoke(new Action(() => { progressWindow.SetProsess(orders.IndexOf(order) + 1, orders.Count); })); } }, _Cts.Token); task.Start(); task.Wait(); }; progressWindow.AbortAction += () => { _Cts.Cancel(); }; var result = progressWindow.ShowDialog(); int leftCount = orders.Count - successCount; if (result == DialogResult.OK || leftCount <= 0) { ShowInfo($"{businessName} 整體完成。"); } else if (result == DialogResult.Abort) { //移到 _Cts.Token.Register 處一起判斷,不然數(shù)目可能不準(zhǔn); //ShowInfo($"{businessName} 有 {leftCount} 項(xiàng)任務(wù)被終止,可在消息框中查看具體項(xiàng)。"); } } /// <summary> /// 業(yè)務(wù)處理方法 /// </summary> private bool BusinessMethod(string order, string businessName) { string errStr = $"【{businessName}】的 {order} 任務(wù)失敗,失敗原因:"; //測(cè)試 Thread.Sleep(1000 * 2); try { //業(yè)務(wù)方法; ShowInfo($"【{businessName}】的 {order} 任務(wù)執(zhí)行成功。"); return true; } catch (Exception ex) { ShowInfo($"{errStr}{ex.Message}"); } return false; } #endregion
四、效果展示和代碼地址
正常執(zhí)行(動(dòng)圖):
中止執(zhí)行(動(dòng)圖):
代碼地址:https://gitee.com/dlgcy/Practice/tree/master/WinFormPractice
轉(zhuǎn)載自 獨(dú)立觀察員•博客
以上就是Winform 實(shí)現(xiàn)進(jìn)度條彈窗和任務(wù)控制的詳細(xì)內(nèi)容,更多關(guān)于Winform 進(jìn)度條彈窗和任務(wù)控制的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- C#使用winform實(shí)現(xiàn)進(jìn)度條效果
- C# Winform下載文件并顯示進(jìn)度條的實(shí)現(xiàn)代碼
- c#進(jìn)度條 progressBar 使用方法的小例子
- asp.net(c#)開(kāi)發(fā)中的文件上傳組件uploadify的使用方法(帶進(jìn)度條)
- c#根據(jù)文件大小顯示文件復(fù)制進(jìn)度條實(shí)例
- C#實(shí)現(xiàn)帶百分比的進(jìn)度條功能示例
- C#中常使用進(jìn)度條的代碼
- C#實(shí)現(xiàn)炫酷啟動(dòng)圖-動(dòng)態(tài)進(jìn)度條效果
- C#實(shí)現(xiàn)帶進(jìn)度條的ListView
- C#?Winform實(shí)現(xiàn)進(jìn)度條顯示
相關(guān)文章
C#訪(fǎng)問(wèn)網(wǎng)絡(luò)共享文件夾的方法
這篇文章主要為大家詳細(xì)介紹了C#訪(fǎng)問(wèn)網(wǎng)絡(luò)共享文件夾的方法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-05-05C# Winform實(shí)現(xiàn)截圖工具的示例代碼
這篇文章主要為大家詳細(xì)介紹了如何使用C# Winform制作一個(gè)簡(jiǎn)單的截圖工具,從而實(shí)現(xiàn)截圖功能,文中的示例代碼講解詳細(xì),有需要的可以參考下2024-02-02詳解C#中使用對(duì)象或集合的初始值設(shè)定項(xiàng)初始化的操作
這篇文章主要介紹了詳解C#中使用對(duì)象或集合的初始值設(shè)定項(xiàng)初始化的操作,文中分別講了對(duì)對(duì)象和字典的初始化,需要的朋友可以參考下2016-01-01C#實(shí)現(xiàn)給函數(shù)添加注釋的小技巧分享
這篇文章主要介紹了C#實(shí)現(xiàn)給函數(shù)添加注釋的小技巧,文中通過(guò)代碼示例給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2024-04-04C#實(shí)現(xiàn)自由組合本地緩存、分布式緩存和數(shù)據(jù)查詢(xún)
這篇文章介紹了C#實(shí)現(xiàn)本地緩存、分布式緩存和數(shù)據(jù)查詢(xún)的方法,文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-07-07c#調(diào)用api控制windows關(guān)機(jī)示例(可以重啟/注銷(xiāo))
本文介紹了c#控制windows關(guān)機(jī)、重啟、注銷(xiāo)的二種方法,分為調(diào)用windows自帶的shutdown.exe關(guān)機(jī)和調(diào)用API關(guān)機(jī)的方法2014-01-01