概述C#復合控件構建
C#復合控件構建
這個ListMover控件包含兩個EnhancedListBox控件,還有一些按鈕用于在兩個列表之間來回移動項。借助于這些C#復合控件構建技術,你可以學習如何創建子控。對于這個控件,你要注意的是某些事情必須發生的位置。
首先,借助于與在以前的控件中相同的技術,你必須把在這個控件中需要的JavaScript代碼添加到OnInit事件的重載版本中。如你在上一個控件中所做的一樣,你也是使用JavaScript存取一個ListBox中的元素。而且,我已經編制了函數分別實現把項添加到一個列表,從一個列表中刪除項,以及從一個列表中添加或刪除所有項。
我已經進行了功能的分離,而不是創建單個“move”方法;這樣以來,我可以實現基于屬性設置而使得從一個列表中刪除項成為可選的。毫無疑問,這可以使最終的控件更為強壯些,但是我在本文中不再分析這些代碼。還應該注意,就象在前面控件中一樣,我也添加了一個BuildItemList方法。
現在,你需要把這一客戶端代碼依附到復合控件的按鈕中。你可以在CreateChildControls方法的最后完成這一點;并且,在此時,完成子控件的初始化和構建控件集合。在此,我僅向你展示相應于一個按鈕的代碼(另外的按鈕代碼與此類似,省略)。
- string s_AddToLeft = "AddSelectedItemToList(document.all." +
- this.lstItemsOnRight.ClientID + ", document.all."
- + this.lstItemsOnLeft.ClientID + ", " +
- (this.AllowDuplicatesOnLeft ? "true" : "false") + "); ";
- string s_RemoveFromRight = "RemoveSelectedItemFromList(document.all." +
- this.lstItemsOnRight.ClientID + "); ";
- string s_BuildItemList = "BuildItemList(document.all." +
- this.lstItemsOnRight.ClientID + ", document.all.__" + lstItemsOnRight.ClientID + ");
- " + "BuildItemList(document.all." + this.lstItemsOnLeft.ClientID + ", document.all.__"
- + lstItemsOnLeft.ClientID + "); ";
- this.btnAdd.Attributes.Add("onclick", s_AddToLeft
- + " " + s_RemoveFromRight + " " + s_BuildItemList
- + " return false");
注意,我實現了在以前的控件中同樣的工作。我把JavaScript函數調用構建成一字符串并且把它們依附到一個按鈕上。主要區別在于,既然這是一個包含其它控件的復合控件,那么你可能使用把代碼添加到onclick事件的Attributes.Add方法,這與在一個生成控件中把它放到一個棧上的方法形成對照。還要注意,我把多個功能放到onclick屬性中;而且,函數調用的最后返回false以便取消按鈕將執行的任何回寄。
最后,代碼將在一個對Render重載的方法中初始化對客戶端函數BuildItemList的調用。這看起來很象我在 EnhancedListBox控件中向你介紹的那個,在此不再重復。注意,在這個控件中,我注冊了兩個隱藏的文本域,每一個相應于一個ListBox。
- protected override void OnPreRender(EventArgs e)
- {
- base.OnPreRender(e);
- if(Page != null)
- {
- Page.ClientScript.ReGISterHiddenField("__" + this.lstItemsOnRight.ClientID,
- "");
- Page.ClientScript.RegisterHiddenField("__" + this.lstItemsOnLeft.ClientID,
- "");
- Page.RegisterRequiresPostBack(this);
- }
- }
現在,C#復合控件構建成功,能夠提供一些客戶端JavaScript,并且把它綁定到按鈕上。與以前一樣,你可以把它放到一個表單上并且使用它;但是,在你添加同步代碼之前,它仍將會遇到你在第一個控件中所遇到的問題—你可以前后移動項,但是一旦你初始化一個回寄(通過表單上的任何其它控件),該控件就會恢復到它回寄之前的狀態。
為了修改這個問題,你要實現你在第一個控件中所做的同樣的工作。然而,既然你在開發一個復合控件,而不是擴展一個已經現有的控件,那么你需要實現IPostBackDataHandler接口并且提供LoadPostData和 RaisePostDataChangedEvent方法的實現代碼。這些實現與前面的控件基本一致,除了你要實現兩個 EnhancedListBox控件中的項集合的同步而不是只考慮一個控件外。并且與以前一樣,你需要確保你保存你的SelectedIndex位置;這樣以來,在你完成項集合的同步后你就可以把它們設置回去。還要注意,在第一個控件中,你重載了基控件的LoadPostData方法,因此在某處調用了它的基類。現在,既然你要從頭編寫一個復合控件,那么就沒有基類可調用,而僅需提供你自己的方法實現。
這個控件的最后版本包含若干新的屬性:包括用來決定是否添加到一個列表中的項能夠被從另一個列表中刪除的屬性(如果一個列表將允許出現重復項的話);它還包含可擴展的風格化以實現最大化重用的目的,等等。
就這些。你已經使用了可用于客戶端腳本中的隱藏的文本域來存儲列表框的狀態。在回寄期間,你使用隱藏文本域的內容來與服務器端項集合重新同步。最終結果是一個漂亮的復合控件—允許你在沒有服務器回寄的情況下實現各列表項間的來回移動,而當一個回寄真正發生時仍能夠保持這種變化。以上介紹C#復合控件構建
【編輯推薦】