[鐵人賽Day14]DotNetNuke模組設計範本–SimpleModule(3)

DAY 14

DotNetNuke的學習心得系列第 10 篇

cms asp.net c# web dotnetnuke dnn

鳴人

2013-10-06 23:13:27

3206 瀏覽

分享至

前兩篇看完了View、Edit型態的UserControl之後，這一篇將要來看最後一種型態的UserControl-Settings。(雖然是Settings UserControl，不過如果讀者有注意.dnn的檔案，將會發現DotNetNuke仍然是在control type定義為Edit)
先來看Settings.ascx和執行的畫面：

在執行的畫面中，讀者會看到有幾個頁籤，其中一個是SimpleModule Settings，是這個模組的設定頁籤，另外三個都是DotNetNuke對於每一個模組基本的設定頁籤。其實說穿了就是在模組的設定頁面中，如果發現這個模組有實作ISettingsControl介面，那麼就會呼叫相對應的實作以載入屬於這個模組的設定值。
在這個模組的設定畫面中，相對也非常簡單的只是設定在View檢視畫面中所要呈現的樣式，而中括號[]加上大寫英文的部份則是在View Control內利用string.Replace的方式來取代值的方式。(請參考這篇)

接下來看看Settings.ascx.cs的內容：

在這邊可以發現和前兩篇所看到繼承的父類別不太一樣，View、Edit Control都是繼承PortalModuleBase父類別，但是Settings Control則是繼承ModuleSettingsBase父類別，並且只有兩個覆寫的公開方法，並沒有其它的事件，有什麼不一樣嗎？

如果讀者在ModuleSettingsBase上按下F12鍵看一下ModuleSettingsBase的定義，就會發現其實ModuleSettingsBase還是繼承了PortalModuleBase這個父類別，並且實作了兩個介面：ISettingsControl、IModuleControl(註)，而ModuleSettingsBase在實作ISettingsControl的時候也只是宣告了兩個虛擬方法，接下來的事就讓繼承它的子類別來去覆寫了，也就是Settings.ascx.cs。

(註：在DotNetNuke的原始檔中，ModuleSettingsBase並沒有宣告實作IModuleControl，實際上在程式碼中也沒有實作的內容，真正實作的是PortalModuleBase父類別。)

最後就來看一下LoadSettings和UpdateSettings的方法吧！

LoadSettings

內容很簡單，只是透過ModuleSettingsBase提供的TabModuleSettings屬性讀取設定值，採用的是Key/Value的方式儲存。

UpdateSettings

在更新設定值的部份並不是和讀取一樣透過ModuleSettingsBase提供的TabModuleSettings屬性，因為ModuleSettingsBase的TabModuleSettings屬性(也就是Hashtable)並沒有辦法偵測處理異動，所以在更新設定值的時候是使用DotNetNuke的ModuleController來Update設定值，需要傳入TableModuleId(PortalModuleBase提供)以及設定的Key/Value。

看完了View、Edit、Settings這三個UserControl之後，讀者覺得哪一個最困難呢？Settings的部份應該是最簡單的吧？事實上就筆者的了解，除了Settings之外，View和Edit Control都可以有多個，只是在處理和實作上就會更複雜些，有興趣的讀者也可以參考DotNetNuke的Blog模組或其它DotNetNuke官方所提供包含原始碼的模組，在CodePlex上DotNetNuke專案網站右下方有個Related Projects區塊，列出了許多相關的模組專案連結。