ASP.NET 魔法學院

前言

在「撰寫自用 Confirm 方法」一文中提到的「案例三：先執行伺服端程式再彈出詢問訊息，依用戶端回應再接續執行」，當用戶端回應詢問訊息後，會呼叫 __doPostBack() 函式來產生 PostBack 的動作，頁面再自行判斷 Me.Request.Form("__EVENTTARGET") 及 Me.Request.Form("__EVENTARGUMENT")  來處理後序的作業。可是這樣處理 PostBack 的方式略顯麻煩，換個角度思考，若 Page 也能像 GridView 一樣具有類似 RowCommand 的事件，可以處理這類的 PostBack 那不是更方便了嗎？所以本文將在 BasePage 加入 PageCommand 事件，針對這個案例改用 PageCommand 來處理。

程式實作

我們將使用「撰寫自用的 ScriptManager 來管理用戶端指令碼」文中提及的 TBBasePage 類別及 TBScriptManager 類別為基礎做擴展。首先在 TBBasePage 新增一個 PageCommand 事件，作法如下。

1.定義 PageCommand 事件。
2.新增 EventTarget 唯讀屬性，傳回 Me.Request.Form("__EVENTTARGET")。
3.新增 EventArgument 唯讀屬性，傳回 Me.Request.Form("__EVENTARGUMENT")。
4.覆寫 OnLoad 方法，判斷 EventTarget 及 EventArgument 屬性值，來決定是否引發 PageCommand 事件。

''' <summary> ''' 頁面基礎類別。 ''' </summary> Public Class TBBasePage Inherits System.Web.UI.Page #Region " PageCommand 事件 " ''' <summary> ''' DayCommand 事件引數。 ''' </summary> Public Class PageCommandEventArgs Inherits System.EventArgs Private FCommandName As String = String.Empty Private FCommandArgument As String = String.Empty ''' <summary> ''' 命令名稱。 ''' </summary> Public Property CommandName() As String Get Return FCommandName End Get Set(ByVal value As String) FCommandName = value End Set End Property ''' <summary> ''' 命令引數。 ''' </summary> Public Property CommandArgument() As String Get Return FCommandArgument End Get Set(ByVal value As String) FCommandArgument = value End Set End Property End Class ''' <summary> ''' 頁面命令事件。 ''' </summary> < _ System.ComponentModel.Description("頁面命令事件。") _ > _ Public Event PageCommand(ByVal sender As Object, ByVal e As PageCommandEventArgs) ''' <summary> ''' 引發 PageCommand 事件。 ''' </summary> Protected Overridable Sub OnPageCommand(ByVal e As PageCommandEventArgs) RaiseEvent PageCommand(Me, e) End Sub #End Region ''' <summary> ''' 觸發 PostBack 的控制項 UniqueID。 ''' </summary> Public ReadOnly Property EventTarget() As String Get Return Me.Request.Form("__EVENTTARGET") End Get End Property ''' <summary> ''' 觸發 PostBack 動作事件引數 。 ''' </summary> Public ReadOnly Property EventArgument() As String Get Return Me.Request.Form("__EVENTARGUMENT") End Get End Property ''' <summary> ''' 判斷二字串是否相同(不區分大小寫)。 ''' </summary> ''' <param name="S1">第一個字串。</param> ''' <param name="S2">第二個字串。</param> Public Shared Function SameText(ByVal S1 As String, ByVal S2 As String) As Boolean If S1 Is Nothing Then Return S2 Is Nothing End If Return S1.Equals(S2, StringComparison.CurrentCultureIgnoreCase) End Function ''' <summary> ''' 覆寫。引發 Load 事件。 ''' </summary> Protected Overrides Sub OnLoad(ByVal e As EventArgs) Dim oArgument() As String Dim oEventArgs As PageCommandEventArgs MyBase.OnLoad(e) If SameText(Me.EventTarget, Me.UniqueID) Then '引發 PageCommand 事件 oArgument = Split(Me.EventArgument, "$") If oArgument.Length = 3 Then If SameText(oArgument(0), "PageCommand") Then oEventArgs = New PageCommandEventArgs() oEventArgs.CommandName = oArgument(1) oEventArgs.CommandArgument = oArgument(2) Me.OnPageCommand(oEventArgs) End If End If End If End Sub End Class

然後在 TBScriptManager 類別新增一個 GetPageCommandEventReference 方法，取得引發 PageCommand 事件的用戶端指令碼。

''' <summary> ''' 用戶端指令碼管理。 ''' </summary> Public Class TBScriptManager ''' <summary> ''' 取得引發 PageCommand 事件的用戶端指令碼。 ''' </summary> ''' <param name="CommandName">命令名稱。</param> ''' <param name="CommandArgument">命令引數。</param> Public Function GetPageCommandEventReference(ByVal CommandName As String, ByVal CommandArgument As String) As String Dim sArgument As String sArgument = String.Format("{0}${1}${2}", "PageCommand", CommandName, CommandArgument) Return Me.GetPostBackEventReference(FPage, sArgument) End Function End Class

PageCommand 事件完成了，我們把「案例三：先執行伺服端程式再彈出詢問訊息，依用戶端回應再接續執行」使用 PageCommand 來改寫，它的程式流程如下。

請假單儲存(伺服端) -> 彈出詢問訊息(用戶端) -> 取得用戶端回應決定是否送審(伺服端)

第一個階段處理「請假單儲存(伺服端) -> 彈出詢問訊息(用戶端) 」，在下面的程式碼中，訊問訊息的回應結果無論是「確定」或「取消」都會引發 PageCommand 事件，CommandName 都是 "SaveConfirm"，差別是 CommandArgument 的值不同。

Protected Sub btnSave_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnSave.Click Dim sTrueScript As String Dim sFalseScript As String '執行請假單儲存的程式碼 '儲存完成彈出詢問訊息 sTrueScript = Me.BeeScript.GetPageCommandEventReference("SaveConfirm", "True") sFalseScript = Me.BeeScript.GetPageCommandEventReference("SaveConfirm", "False") Me.BeeScript.Confirm("假單要送審嗎?", sTrueScript, sFalseScript) End Sub

第二階段在 PageCommand 事件處理用戶端詢問訊息的回應「取得用戶端回應決定是否送審(伺服端)」，在 PageCommand 事件中，我們只需判斷 e.CommandName 及 e.CommandArgument 來決定接續的執行動作即可。

Protected Sub Page_PageCommand(ByVal sender As Object, ByVal e As Bee.Web.TBBasePage.PageCommandEventArgs) Handles Me.PageCommand If String.Equals(e.CommandName, "SaveConfirm", StringComparison.CurrentCultureIgnoreCase) Then If String.Equals(e.CommandArgument, "True", StringComparison.CurrentCultureIgnoreCase) Then '按了確定要執行的程式碼 Else '按了取消要執行的程式碼 End If End If End Sub

前言

上一篇「讓 ASP.NET 也可以使用 MsgBox 方法」文章中提到如何封裝 JavaScript 的 alert 方法，另一個常使用在用戶端處理「詢問訊息」的就是 JavaScript 的 confirm 方法，在此篇文章我們將撰寫自用的 Confirm 方法，使頁面的程式碼儘量不要直接去撰寫 JavaScript 程式碼，以增加系統的維護性。

程式實作

我們將使用「撰寫自用的 ScriptManager 來管理用戶端指令碼」文中提及的 TBScriptManager 類別為基礎，在 TBScriptManager 類別新增處理「詢問訊息」會使用到相關方法。我們在 TBScriptManager 類別新增二個 GetConfirmScript 多載方法，用以取得詢問訊息相關的 JavaScript 程式碼；另新增 Confirm 方法來直接註冊詢問訊息的用戶端指令碼，以下將以實例說明這三個方法的使用時機及方式。

''' <summary> ''' 用戶端指令碼管理。 ''' </summary> Public Class TBScriptManager ''' <summary> ''' 處理訊息文字的跳脫字元。 ''' </summary> ''' <param name="Message">訊息文字。</param> Private Function ParserMessage(ByVal Message As String) As String Dim sMessage As String sMessage = Strings.Replace(Message, "'", "\'") '處理單引號 sMessage = Strings.Replace(sMessage, vbNewLine, "\n") '處理換行 Return sMessage End Function ''' <summary> ''' 取得訊問視窗的用戶端指令碼。 ''' </summary> ''' <param name="Message">訊息文字。</param> Public Overloads Function GetConfirmScript(ByVal Message As String) As String Dim sMessage As String Dim sScript As String sMessage = ParserMessage(Message) sScript = String.Format("if (confirm('{0}')==false) {{return false;}}", sMessage) Return sScript End Function ''' <summary> ''' 取得訊問視窗的用戶端指令碼。 ''' </summary> ''' <param name="Message">訊息文字。</param> ''' <param name="TrueScript">回應 true 時要執行的用戶端指令碼。</param> ''' <param name="FalseScript">回應 false 時要執行的用戶端指令碼。</param> Public Overloads Function GetConfirmScript(ByVal Message As String, _ ByVal TrueScript As String, ByVal FalseScript As String) As String Dim sMessage As String Dim sScript As String sMessage = ParserMessage(Message) sScript = String.Format("if (confirm('{0}')){{ {1} }} else {{ {2} }}", sMessage, TrueScript, FalseScript) Return sScript End Function ''' <summary> ''' 詢問視窗。 ''' </summary> ''' <param name="Message">訊息文字。</param> ''' <param name="TrueScript">回應 true 時要執行的用戶端指令碼。</param> ''' <param name="FalseScript">回應 false 時要執行的用戶端指令碼。</param> Public Sub Confirm(ByVal Message As String, ByVal TrueScript As String, ByVal FalseScript As String) Dim sScript As String sScript = GetConfirmScript(Message, TrueScript, FalseScript) Me.RegisterStartupScript("Confirm", sScript) End Sub End Class

案例一：按鈕加上詢問訊息，按「確定」才會引發按鈕的 Click 事件

按鈕加上詢息訊息是常使用到的案例，例如按下刪除鈕時，先詢問用戶是否確定刪除資料，當按「確定」時才會真正去執行刪除動作。我們可以在 Page Load 事件中，去設定 Button.OnClientClick 屬性，加入詢問訊息的用戶端指令碼。

Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load Button1.OnClientClick = Me.BeeScript.GetConfirmScript("確定刪除此筆資料嗎?") End Sub

案例二：純用戶端的詢問訊息

詢問訊息只是在用戶端執行，並不會產生 PostBack。

Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load Dim sScript As String sScript = Me.BeeScript.GetConfirmScript("純用戶端的詢問訊息?", "alert('按了確定')", "alert('按了取消')") HyperLink1.Attributes("onclick") = sScript End Sub

案例三：先執行伺服端程式再彈出詢問訊息，依用戶端回應再接續執行

例如有登打請假單儲存時，執行儲存完畢要彈出一個是否送審詢問訊息。在 WinForm 撰寫這個程式碼非常單純，只要在儲存後彈出詢問訊息，等待用戶回應接續執行後面的程式碼即可。可是在 WebForm 要撰寫相同的功能就有點麻煩了，因為整個程式的流程是在伺服端及用戶端交互運作。

請假單儲存(伺服端) -> 彈出詢問訊息(用戶端) -> 取得用戶端回應決定是否送審(伺服端)

在 WebForm 要處理這類問題，要分為二個階段處理，第一個階段處理「請假單儲存(伺服端) -> 彈出詢問訊息(用戶端) 」，在下面的程式碼中，訊問訊息的回應結果無論是「確定」或「取消」都會產生 PostBack 動作傳不同的參數。

Protected Sub btnSave_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnSave.Click Dim sTrueScript As String Dim sFalseScript As String '執行請假單儲存的程式碼 '儲存完成彈出詢問訊息，__EVENTTARGET 設為 "SaveConfirm" sTrueScript = "__doPostBack('SaveConfirm','True')" sFalseScript = "__doPostBack('SaveConfirm','False')" Me.BeeScript.Confirm("假單要送審嗎?", sTrueScript, sFalseScript) End Sub

第二階段在 Page Load 事件處理用戶端詢問訊息的回應「取得用戶端回應決定是否送審(伺服端)」

Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load '處理詢問訊息的回應 Dim sEventTarget As String = Me.Request.Form("__EVENTTARGET") Dim sEventArgument As String = Me.Request.Form("__EVENTARGUMENT") If String.Equals("SaveConfirm", sEventTarget, StringComparison.CurrentCultureIgnoreCase) Then If String.Equals(sEventArgument, "True", StringComparison.CurrentCultureIgnoreCase) Then '按了確定要執行的程式碼 End If If String.Equals(sEventArgument, "False", StringComparison.CurrentCultureIgnoreCase) Then '按了取消要執行的程式碼 End If End If End Sub

使用 VB6 或 VB.NET 的開發人員，一定常會使用到 MsgBox 這個函式來顯示訊息，如果使用 VB.NET 在開發 ASP.NET 程式，會發現似乎 MsgBox 這個函式好像可以使用，就直接使用 MsgBox 來顯示訊息。

MsgBox("這是訊息")

在 VS 開發環境中執行程式，MsgBox 函式好像也可以正常顯示訊息；可是一旦網站發佈出去後，就會發現 MsgBox 函式失效了。這是什麼原因呢？MsgBox 函式是伺服端的語言，而用戶端只能透過瀏覽器解析 HTML 及 JavaScript，所以 MsgBox 函式是無法使用在 ASP.NET 的程式，只能在開發偵錯時使用。在 ASP.NET 中，要在用戶端顯示訊息正確的方法是要使用 RegisterStartupScript 方法來輸出 JavaScript 的 alert 函式。

ScriptManager.RegisterStartupScript(Me, Me.GetType(), "alert", "alert('這是訊息')", True) 或 Me.ClientScript.RegisterStartupScript(Me.GetType(), "alert", "alert('這是訊息')", True)

是不是覺得在 ASP.NET 中要顯示訊息麻煩多了，能否讓 ASP.NET 中也可以使用 MsgBox 來顯示訊息呢？其實方法很簡單，就是自己寫一個 MsgBox 方法就好了，就可以延用以前習慣的 MsgBox 來顯示訊息。我們在 BasePage 中撰寫 MsgBox 方法，這個 MsgBox 方法還處理訊息文字中含「單引號」及「換行」的部分，將這些特殊字串轉換為對應的 JavaScript 跳脫字元。

''' <summary> ''' 彈出提示訊息。 ''' </summary> ''' <param name="Message">訊息文字。</param> Public Sub MsgBox(ByVal Message As String) Dim sScript As String Dim sMessage As String sMessage = Strings.Replace(Message, "'", "\'") '處理單引號 sMessage = Strings.Replace(sMessage, vbNewLine, "\n") '處理換行 sScript = String.Format("alert('{0}');", sMessage) ScriptManager.RegisterStartupScript(Me, Me.GetType(), "alert", sScript, True) End Sub

所有繼承 BasePage 的頁面都可以使用 MsgBox 方法來顯示訊息。

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles Button1.Click Dim sMessage As String sMessage = "alert 訊息換行測試" & vbNewLine & "測試'單引號' " MsgBox(sMessage) End Sub

備註：處理 JavaScript 的相關函式，筆者比較建議使用「撰寫自用的 ScriptManager 來管理用戶端指令碼」一文中提供的方式來處理，所以可以將 MsgBox 方法撰寫在該文中的 TBScriptManager 類別。

Strings.Replace 方法是用在字串取代常用方法，常用的呼叫方式如下

Strings.Replace("原字串","尋找的字串","取代的字串")

可是最近發現一個問題，就是當原字串為 String.Empty (空字串) 時，其傳回值會為 Nothing。

如下程式碼會發生「參考的物件具有 'Nothing' 的值」的錯誤訊息。因為原字串為空字串，透過 Strings.Replace 方法會傳回 Nothing，所以會造成這個錯誤。

Strings.Replace(string.Empty,"@","").Length

所以在使用 Strings.Replace 方法要特別注意這點，防止發生異常的錯誤。而我的作法就是撰寫另一個 StrReplace 方法來取代 Strings.Replace 方法，防止這類錯誤。

''' <summary> ''' 字串取代。 ''' </summary> ''' <param name="Expression">原始字串。</param> ''' <param name="Find">搜尋的子字串。</param> ''' <param name="Replacement">取代的子字串。</param> Public Shared Function StrReplace(ByVal Expression As String, _ ByVal Find As String, ByVal Replacement As String) As String If String.IsNullOrEmpty(Expression) Then Return String.Empty Else Return Replace(Expression, Find, Replacement) End If End Function

摘要

之前在「Calendar 動態產生子控制項的 Event Handler」一文中有提到如何處理 Calendar 在 DayRender 事件動態產生按鈕的事件處理，文中最後有提及，若 Calendar 控制項有類似 GridView 控制項中有 RowCommand 事件，在使用上就可以更簡化。所以本文將擴展 Calendar 控制項，新增 DayCommand 事件，就動態產生的按鈕可以可以引發 DayCommand 事件，以便做後序的命令處理。

擴展 Calendar 控制項

繼承 Calendar 命名為 TBCalendar，新增 DayCommand 事件，覆寫 RaisePostBackEvent 方法，此方法是在處理引發 PostBack 產生的控制項事件，在此判斷若 PostBack 傳入的引數為 DayCommand${0}${1} 格式 (其中 {0} 為 CommandName，{1} 為日期)，則引發 DayCommand 事件。另外新增 GetDayCommandEventReference 方法，提供取得引發 DayCommand 事件的用戶端指令碼。

''' <summary> ''' 月曆控制項。 ''' </summary> < _ Description("月曆控制項。"), _ ToolboxData("<{0}:TBCalendar runat=server></{0}:TBCalendar>") _ > _ Public Class TBCalendar Inherits Calendar #Region " DayCommand 事件 " ''' <summary> ''' DayCommand 事件引數。 ''' </summary> Public Class DayCommandEventArgs Inherits System.EventArgs Private FCommandName As String = String.Empty Private FDate As Date = Date.MinValue ''' <summary> ''' 命令名稱。 ''' </summary> Public Property CommandName() As String Get Return FCommandName End Get Set(ByVal value As String) FCommandName = value End Set End Property ''' <summary> ''' 日期。 ''' </summary> Public Property [Date]() As Date Get Return FDate End Get Set(ByVal value As Date) FDate = value End Set End Property End Class ''' <summary> ''' 日期儲存格引發的命令事件。 ''' </summary> < _ System.ComponentModel.Category(WebCommon.Category.Action), _ System.ComponentModel.Description("日期儲存格引發的命令事件。") _ > _ Public Event DayCommand(ByVal sender As Object, ByVal e As DayCommandEventArgs) ''' <summary> ''' 引發 DayCommand 事件。 ''' </summary> Protected Overridable Sub OnDayCommand(ByVal e As DayCommandEventArgs) RaiseEvent DayCommand(Me, e) End Sub #End Region ''' <summary> ''' 引發 PostBack 產生的控制項事件。 ''' </summary> Protected Overrides Sub RaisePostBackEvent(ByVal eventArgument As String) Dim oArgument() As String Dim oEventArgs As DayCommandEventArgs If String.Compare(eventArgument, 0, "DayCommand", 0, "DayCommand".Length, StringComparison.Ordinal) = 0 Then oArgument = Split(eventArgument, "$") If oArgument.Length <> 3 Then Exit Sub oEventArgs = New DayCommandEventArgs() oEventArgs.CommandName = oArgument(1) oEventArgs.Date = Date.Parse(oArgument(2)) OnDayCommand(oEventArgs) Exit Sub End If MyBase.RaisePostBackEvent(eventArgument) End Sub ''' <summary> ''' 取得引發 DayCommand 事件的用戶端指令碼。 ''' </summary> ''' <param name="CommandName">命令名稱。</param> ''' <param name="Date">日期。</param> Public Function GetDayCommandEventReference(ByVal CommandName As String, ByVal [Date] As Date) As String Dim sArgument As String sArgument = String.Format("DayCommand${0}${1}", CommandName, [Date].ToShortDateString) Return Me.Page.ClientScript.GetPostBackEventReference(Me, sArgument) End Function End Class

測試程式

在頁面上放置 TBCalendar 控制項，在 DayRender 事件中動態產生一個 HtmlButton 按鈕，並利用 GetDayCommandEventReference 方法取得引發 DayCommand 事件的用戶端指令碼。在 DayCommand 事件中將 e.CommandName 及 e.Date 輸出在頁面上。

Protected Sub Calendar1_DayRender(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.DayRenderEventArgs) Handles Calendar1.DayRender Dim oButton As HtmlButton oButton = New HtmlButton() oButton.InnerText = "刪除" oButton.Attributes("onclick") = Calendar1.GetDayCommandEventReference("Delete", e.Day.Date) e.Cell.Controls.Add(oButton) End Sub Protected Sub Calendar1_DayCommand(ByVal sender As Object, ByVal e As Bee.Web.WebControls.TBCalendar.DayCommandEventArgs) Handles Calendar1.DayCommand Me.Response.Write(String.Format("DayCommand: {0} Date: {1}", e.CommandName, e.Date.ToShortDateString)) End Sub

執行程式，按下某一日期的 [刪除] 鈕，就會引發其對應的 DayCommand 事件。