Webpart‘SiderBar---自定義配置屬性

 

      今天筆者向大家介紹如何實現SideBar的定製,這部分可讓筆者吃了不少苦頭,走了不少彎路,我相信介紹完這部分內容後,大家就能夠發揮各自的想象力開發出豐富而又實用的SideBar了,先解釋下什麼叫SideBar,顧名思義,翻譯成中文就是”邊欄”,每當我們編輯頁面的WebPart時,頁面的右邊會彈出一個屬性設置工具欄,這就是SideBar,下面筆者通過一個Demo給大家演示,當然這個Demo是基於上幾篇的內容,如果您還不瞭解前面幾部分內容的話,建議您先閱讀下之前的文章

在原有的項目基礎上添加一個類,取名爲”MySideBar.cs”

      下面的編程中需要使用到QuickPart程序集下的類,所以必須添加對QuickPart.dll的引用,有的朋友可能會問QuickPart.dll的所在位置,筆者告訴您,如果您使用的是1.0版本QuickPart,那麼部署完後會在”C:/Inetpub/wwwroot/wss/VirtualDirectories/80/bin”目錄下生成該程序集,如果您使用的是1.0.3版本則會部署至GAC(Global Application Cache)目錄下,路徑通常爲”C:/Windows/assembly/” 

MySideBar.cs代碼如下:

using Microsoft.SharePoint; using Microsoft.PRC.SharePoint; namespace BindDocLibrary_APP { //繼承EditorPart類 public class MySideBar:EditorPart { DropDownList ddlDocLibNameList; //EditorPart類的抽象方法,當點下SideBar上的"應用"按鈕時觸發 public override bool ApplyChanges() { //判斷服務器控件是否包含子控件,若不包含,則創建子控件 EnsureChildControls(); //獲取當前正在編輯的webpart控件,將其轉換成QuickPart類型 QuickPart quickPart = WebPartToEdit as QuickPart; //獲取該quickPart裏面包含的控件 Control currentControl = quickPart.Controls[0]; //TreeCatalog類爲筆者上幾篇所建的樹行目錄 TreeCatalog trCatalog = currentControl as TreeCatalog; //當點擊"應用"按鈕時,將SideBar上的設置賦給trCatalog類下的文檔庫屬性 trCatalog.DocLibName = ddlDocLibNameList.SelectedValue; return true; } //EditorPart類的抽象方法,當您點下"修改共享web部件"按鈕時觸發 public override void SyncChanges() { EnsureChildControls(); QuickPart quickPart = WebPartToEdit as QuickPart; Control currentControl = quickPart.Controls[0]; TreeCatalog trCatalog = currentControl as TreeCatalog; //此時是將您webpart上的屬性值回調並顯示到sidebar對應欄中的過程 ddlDocLibNameList.SelectedValue = trCatalog.DocLibName; } //重寫該方法的目的是將我們想要的內容輸出到SideBar面板上 public override void RenderControl(HtmlTextWriter writer) { writer.Write("請選擇文檔庫"); //將服務器控件內容輸出到SideBar面板,這裏會輸出筆者一開始定義的列表框"ddlDocLibNameList" base.RenderControl(writer); } //重寫創建子控件方法 protected override void CreateChildControls() { ddlDocLibNameList = new DropDownList(); //獲得當前http請求的web頁面 SPWeb spWeb = SPContext.Current.Web; //遍歷該頁面的所有列表,記住,文檔庫是一種特殊的列表 foreach (SPList spList in spWeb.Lists) { //將所有的列表名稱添加到下拉列表框控件中 ddlDocLibNameList.Items.Add(new ListItem(spList.Title)); } //最後要記得添加該控件到頁面上,切忌在寫成Page.Controls.Add(ddlDocLibNameList) Controls.Add(ddlDocLibNameList); base.CreateChildControls(); } } } 

 TreeCatalog.ascx.cs文件在筆者原有代碼上添加如下代碼:  

/*首先修改TreeCatalog繼承IWebEditable類: public partial class TreeCatalog : System.Web.UI.UserControl,IWebEditable 實現IWebEditable類的所有方法如下: */ #region IWebEditable 成員 public EditorPartCollection CreateEditorParts() { MySideBar mySideBar = new MySideBar(); mySideBar.Title = "文檔庫列表"; mySideBar.ID = this.ID + "_SideBar"; ArrayList arrList = new ArrayList(); arrList.Add(mySideBar); return new EditorPartCollection(arrList); } public object WebBrowsableObject { get { return this; } } #endregion 

這段代碼大家都看得懂,筆者就不註釋了,我們來看下最後的效果

依次選擇”網站操作”->”編輯頁面”,在左欄區域依次選擇”編輯”->”修改共享web部件”,就可以在頁面右邊的sidebar看到如上圖顯示的效果