前言:前兩篇我們封裝了一些基礎的表單組件,這篇繼續封裝幾個基於 Bootstrap 的其他組件。與上篇不同的是,這篇的部分組件需要搭配特定的 JS 文件才能運作。
BootstrapHelper 系列文章目錄:
C# 進階系列——逐步封裝自己的 HtmlHelper 組件:BootstrapHelper
C# 進階系列——逐步封裝自己的 HtmlHelper 組件:BootstrapHelper(二)
C# 進階系列——逐步封裝自己的 HtmlHelper 組件:BootstrapHelper(三:附源碼)
一、NumberBoxExtensions
NumberBoxExtensions 是一個 Bootstrap 風格的數字文本框,是基於先前介紹過的自增器數字組件 spinner 所做的封裝。不熟悉的園友可以參考 https://www.jb51.net/article/88490.htm 中介紹的第二個組件。
我們知道,spinner 自增組件的初始化不需要寫任何 JS,直接透過設定 HTML 裡的 data 屬性即可。這讓封裝變得輕鬆許多——我們只要把常用的初始化參數作為擴展方法的參數傳入,再在後端轉成對應的 data 屬性回傳前端即可。先上源碼:
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; namespace BootstrapExtensions { public static class NumberBoxExtensions { /// <summary> /// 生成數字文本框 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <returns>返回數字文本框</returns> public static MvcHtmlString NumberTextBox(this BootstrapHelper html, string id) { return NumberTextBox(html, id, null, null, null, null, null); } /// <summary> /// 生成數字文本框 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">文本框的value值</param> /// <returns>返回數字文本框</returns> public static MvcHtmlString NumberTextBox(this BootstrapHelper html, string id, object value) { return NumberTextBox(html, id, value, null, null, null, null); } /// <summary> /// 生成數字文本框 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="value">文本框的value值</param> /// <param name="min">自增長的最小值</param> /// <param name="max">自增長的最大值</param> /// <returns>返回數字文本框</returns> public static MvcHtmlString NumberTextBox(this BootstrapHelper html, object value, int? min, int? max) { return NumberTextBox(html, null, value, min, max, null, null); } /// <summary> /// 生成數字文本框 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">文本框的value值</param> /// <param name="min">自增長的最小值</param> /// <param name="max">自增長的最大值</param> /// <returns>返回數字文本框</returns> public static MvcHtmlString NumberTextBox(this BootstrapHelper html, string id, object value, int? min, int? max) { return NumberTextBox(html, id, value, min, max, null, null); } /// <summary> /// 生成數字文本框 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">文本框的value值</param> /// <param name="min">自增長的最小值</param> /// <param name="max">自增長的最大值</param> /// <param name="step">每次自增的數字</param> /// <returns>返回數字文本框</returns> public static MvcHtmlString NumberTextBox(this BootstrapHelper html, string id, object value, int? min, int? max, int? step) { return NumberTextBox(html, id, value, min, max, step, null); } /// <summary> /// 生成數字文本框 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">文本框的value值</param> /// <param name="min">自增長的最小值</param> /// <param name="max">自增長的最大值</param> /// <param name="step">每次自增的數字</param> /// <param name="rule">自增規則</param> /// <returns>返回數字文本框</returns> public static MvcHtmlString NumberTextBox(this BootstrapHelper html, string id, object value, int? min, int? max, int? step, SpinningRule? rule) { TagBuilder tag = new TagBuilder("div"); tag.MergeAttribute("class", "input-group spinner"); tag.MergeAttribute("data-trigger", "spinner"); System.Text.StringBuilder sb = new System.Text.StringBuilder(); //sb.Append("<input type='text' class='form-control text-center' value='1' data-min='-10' data-max='10' data-step='2' data-rule='quantity'>"); sb.Append("<input type='text' class='form-control text-center' "); if (!string.IsNullOrEmpty(id)) { sb.Append("id='").Append(id).Append("' "); } if (value != null) { sb.Append("value='").Append(value.ToString()).Append("' "); } else { sb.Append("value='1' "); } if (min != null) { sb.Append("data-min='").Append(min).Append("' "); } if (max != null) { sb.Append("data-max='").Append(max).Append("' "); } if (step != null) { sb.Append("data-step='").Append(step).Append("' "); } if (rule != null) { sb.Append("data-rule='").Append(rule.ToString()).Append("' "); } else { sb.Append("data-rule='quantity' "); } sb.Append("/>"); sb.Append("<span class='input-group-addon'>"); sb.Append("<a href='javascript;;' class='spin-up' data-spin='up'><i class='fa fa-caret-up'></i></a>"); sb.Append("<a href='javascript:;' class='spin-down' data-spin='down'><i class='fa fa-caret-down'></i></a>"); sb.Append("</span>"); tag.InnerHtml = sb.ToString(); return MvcHtmlString.Create(tag.ToString()); } } public enum SpinningRule { defaults, currency, quantity, percent, month, day, hour, minute, second, } } 除去 id 與 value,自增組件初始化需要的主要參數就是 min、max、step、rule,分別對應組件的 data-min、data-max、data-step、data-rule。使用相當簡單,先在頁面引入相關的 JS 與 CSS,然後在 cshtml 裡這樣呼叫即可:
代碼如下:@Bootstrap.NumberTextBox(null, "1", 1, 10, 2, null)
得到結果:

這樣是不是比每次都得複製一大段 HTML 方便多了呢?
二、DateTimeBoxExtensions
有了數字組件打底,接下來就是封裝時間組件了。原本我也想沿用 data 屬性做初始化,但翻了半天文檔,發現 datetimepicker 並沒有自帶 data 屬性初始化的方式,只好自己动手實作。
1、初始方案
先建立一個檔案 bootstrap-datetimepicker-helper.js,代碼如下:
$(function () { var datetimedefault = { locale: 'zh-CN', //中文化 }; $.each($(".date"), function (index, item) { var data = $(item).data(); var param = $.extend({}, datetimedefault, data || {}); $(item).datetimepicker(param); }); }); HTML 則這樣寫:
<div class='input-group date' data-format="YYYY-MM-DD" data-maxDate="2017-01-10" data-minDate="2010-01-10"> <input type='text' class="form-control" /> <span class="input-group-addon"> <span class="glyphicon glyphicon-calendar"></span> </span> </div>
乍看之下似乎沒問題,但事與願違!這裡忽略了一點:jQuery 的 data() 方法會把屬性名全部轉成小寫,也就是說,HTML 裡寫的 data-maxDate,透過 data() 得到卻變成了 maxdate,如下圖:

於是初始化 datetimepicker 時便拋出了 JS 異常,此法行不通。
2、改進方案
既然行不通,那就得改進。找了一圈也沒發現 data() 有不轉小寫的參數,最後只好自行改造,JS 代碼變成了這樣:
$(function () { var datetimedefault = { format: 'YYYY-MM-DD',//日期格式化,只顯示日期 locale: 'zh-CN', //中文化 maxDate: '2017-01-01',//最大日期 minDate: '2010-01-01', //最小日期 viewMode: 'days', defaultDate: false, disabledDates: false, enabledDates: false, }; $.each($(".date"), function (index, item) { var data = $(item).data(); $.each(data, function (key, value) { for (i in datetimedefault) { if (key == i.toLowerCase()) { datetimedefault[i] = value; break; } } }); //var param = $.extend({}, datetimedefault, data || {}); $(item).datetimepicker(datetimedefault); }); }); 原理是把 data() 得到的結果與 datetimedefault 的屬性名轉小寫後比對,若相同,就用 HTML 裡的 data 屬性覆蓋預設值。測試幾遍後基本沒問題。這種寫法雖然能解決問題,但前提是 datetimedefault 裡必須包含足夠多的預設參數,才能達到覆蓋目的;實務上通常也只需加上幾個常變的屬性即可。
有了這層理論基礎,DataTimeBox 的封裝就水到渠成了,直接上代碼:
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; namespace BootstrapExtensions { public static class DateTimeBoxExtensions { /// <summary> /// 生成日期控件 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">文本框標簽的id</param> /// <returns>返回呈現日期控件的html標簽</returns> public static MvcHtmlString DateTimeBox(this BootstrapHelper html, string id) { return DateTimeBox(html, id, null, null, null, null, null, null); } /// <summary> /// 生成日期控件 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">文本框標簽的id</param> /// <param name="value">文本框標簽的默認值</param> /// <returns>返回呈現日期控件的html標簽</returns> public static MvcHtmlString DateTimeBox(this BootstrapHelper html, string id, object value) { return DateTimeBox(html, id, value, null, null, null, null, null); } /// <summary> /// 生成日期控件 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">文本框標簽的id</param> /// <param name="value">文本框標簽的默認值</param> /// <param name="format">顯示日期的格式</param> /// <param name="maxDate">日期的最大值</param> /// <param name="minDate">日期的最小值</param> /// <returns>返回呈現日期控件的html標簽</returns> public static MvcHtmlString DateTimeBox(this BootstrapHelper html, string id, object value, string format, string maxDate, string minDate) { return DateTimeBox(html, id, value, format, maxDate, minDate, null, null); } /// <summary> /// 生成日期控件 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">文本框標簽的id</param> /// <param name="value">文本框標簽的默認值</param> /// <param name="format">顯示日期的格式</param> /// <param name="maxDate">日期的最大值</param> /// <param name="minDate">日期的最小值</param> /// <param name="viewMode">日期控件的浏覽模式</param> /// <param name="showClear">是否顯示清空按鈕</param> /// <returns>返回呈現日期控件的html標簽</returns> public static MvcHtmlString DateTimeBox(this BootstrapHelper html, string id, object value, string format, string maxDate, string minDate, string viewMode, bool? showClear) { TagBuilder tag = new TagBuilder("div"); tag.MergeAttribute("class", "input-group date"); if (!string.IsNullOrEmpty(format)) { tag.MergeAttribute("data-format", format); } if (!string.IsNullOrEmpty(maxDate)) { tag.MergeAttribute("data-maxDate", maxDate); } if (!string.IsNullOrEmpty(minDate)) { tag.MergeAttribute("data-minDate", minDate); } if (!string.IsNullOrEmpty(viewMode)) { tag.MergeAttribute("data-viewMode", viewMode); } if (showClear!=null) { tag.MergeAttribute("data-showClear", showClear.ToString()); } System.Text.StringBuilder sb = new System.Text.StringBuilder(); sb.Append("<input type='text' class='form-control'"); if(!string.IsNullOrEmpty(id)) { sb.Append("id='").Append(id).Append("' "); } if (value != null) { sb.Append("value='").Append(value.ToString()).Append("' "); } sb.Append("/>").Append("<span class='input-group-addon'>") .Append("<span class='glyphicon glyphicon-calendar'></span>") .Append("</span>"); tag.InnerHtml = sb.ToString(); return MvcHtmlString.Create(tag.ToString()); } } } 接著在 cshtml 頁面引入我們的 JS 與 CSS:
<link href="~/Content/bootstrap-datetimepicker/css/bootstrap-datetimepicker.css" rel="stylesheet" /> <script src="~/Content/bootstrap-datetimepicker/js/moment-with-locales.js"></script> <script src="~/Content/bootstrap-datetimepicker/js/bootstrap-datetimepicker.min.js"></script> <script src="~/Content/bootstrap-datetimepicker/js/bootstrap-datetimepicker-helper.js"></script>
然後直接使用:
<div class="col-xs-3"> @Bootstrap.DateTimeBox("starttime", null, null, null, null, null, null) </div> <div class="col-xs-3"> @Bootstrap.DateTimeBox("endtime", null, null, null, null, null, null) </div> 得到結果:

三、TextareExtensions
textarea 文本域的封裝相對簡單,因為它的結構和 TextBox 差不多,直接上源碼:
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; namespace BootstrapExtensions { public static class TextareExtensions { /// <summary> /// textarea文本域 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <returns>html標簽</returns> public static MvcHtmlString TextAreaBox(this BootstrapHelper html, string id) { return TextAreaBox(html, id, null, null, null, null); } /// <summary> /// textarea文本域 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">value</param> /// <param name="cssClass">樣式</param> /// <returns>html標簽</returns> public static MvcHtmlString TextAreaBox(this BootstrapHelper html, string id, object value, string cssClass) { return TextAreaBox(html, id, value, cssClass, null, null); } /// <summary> /// textarea文本域 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">value</param> /// <param name="cssClass">樣式</param> /// <param name="rows">行數</param> /// <returns>html標簽</returns> public static MvcHtmlString TextAreaBox(this BootstrapHelper html, string id, object value, string cssClass, int? rows) { return TextAreaBox(html, id, value, cssClass, rows, null); } /// <summary> /// textarea文本域 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">id</param> /// <param name="value">value</param> /// <param name="cssClass">樣式</param> /// <param name="rows">行數</param> /// <param name="cols">列數</param> /// <returns>html標簽</returns> public static MvcHtmlString TextAreaBox(this BootstrapHelper html, string id, object value, string cssClass, int? rows, int? cols) { TagBuilder tag = new TagBuilder("textarea"); tag.AddCssClass("form-control"); if (!string.IsNullOrEmpty(id)) { tag.MergeAttribute("id", id); } if (value != null) { tag.MergeAttribute("value", value.ToString()); } if (!string.IsNullOrEmpty(cssClass)) { tag.AddCssClass(cssClass); } if (rows != null) { tag.MergeAttribute("rows", rows.ToString()); } if (cols != null) { tag.MergeAttribute("cols", cols.ToString()); } return MvcHtmlString.Create(tag.ToString()); } } } 只支援 rows 與 cols 這兩個最簡單的參數,若你的項目有特殊需求,例如想初始化成富文本編輯框,也可以自行改進。
使用方法
<div> @Bootstrap.TextAreaBox("id", "", "", 3, 5) </div>這裡有個問題要提醒:這樣寫出來的結果如下圖,cols 屬性似乎沒起作用。

原因在於,只要標籤加了 class='form-control' 樣式,它就會撐滿整個 div。解法很簡單,在外層的 div 上做些處理即可:
代碼如下:<div> @Bootstrap.TextAreaBox("", "", "", 3, 5) </div>

既然 cols 屬性起不了作用,其實參數裡的 cols 也可以考慮拿掉。
四、SelectExtensions
又到了最令人糾結的 select 下拉框。之所以說它糾結,是因為封裝時要權衡的問題太多,例如:<optgroup> 與 <option> 該如何處理、靜態的 option 值如何傳到後端、究竟要封裝原生 select 還是封裝成基於某些組件(如 select2)的 select、方法與事件又該如何設計等等。
後來轉念一想,封裝的目的不就是為了用起來更方便嗎?如果封得太死,反而不好用。於是乾脆封裝成最簡單的 select:靜態 option 直接寫原生 select 標籤;動態 option 則傳對應的 url 到後端,取到資料後再生成 option。封裝代碼如下:
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Mvc; namespace BootstrapExtensions { public static class SelectExtensions { /// <summary> /// 返回select標簽 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">標簽id</param> /// <returns>select標簽</returns> public static MvcHtmlString SelectBox(this BootstrapHelper html, string id) { return SelectBox(html, id, null, null, null, null, null, null); } /// <summary> /// 返回select標簽 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">標簽id</param> /// <param name="value">標簽選中值</param> /// <returns>select標簽</returns> public static MvcHtmlString SelectBox(this BootstrapHelper html, string id, object value) { return SelectBox(html, id, value, null, null, null, null, null); } /// <summary> /// 返回select標簽 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">標簽id</param> /// <param name="value">標簽選中值</param> /// <param name="cssClass">標簽樣式</param> /// <returns>select標簽</returns> public static MvcHtmlString SelectBox(this BootstrapHelper html, string id, object value, string cssClass) { return SelectBox(html, id, value, cssClass, null, null, null, null); } /// <summary> /// 返回select標簽 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">標簽id</param> /// <param name="value">標簽選中值</param> /// <param name="cssClass">標簽樣式</param> /// <param name="url">請求數據的url</param> /// <param name="textField">顯示字段</param> /// <param name="valueField">值字段</param> /// <returns>select標簽</returns> public static MvcHtmlString SelectBox(this BootstrapHelper html, string id, object value, string cssClass, string url, string textField, string valueField) { return SelectBox(html, id, value, cssClass, url, null, textField, valueField); } /// <summary> /// 返回select標簽 /// </summary> /// <param name="html">擴展方法實例</param> /// <param name="id">標簽id</param> /// <param name="value">標簽選中值</param> /// <param name="cssClass">標簽樣式</param> /// <param name="url">請求數據的url</param> /// <param name="param">請求的參數</param> /// <param name="textField">顯示字段</param> /// <param name="valueField">值字段</param> /// <param name="multiple">是否多選</param> /// <returns>select標簽</returns> public static MvcHtmlString SelectBox(this BootstrapHelper html, string id, object value, string cssClass, string url, string param, string textField, string valueField, bool multiple = false) { TagBuilder tag = new TagBuilder("select"); tag.AddCssClass("form-control"); if (!string.IsNullOrEmpty(id)) { tag.MergeAttribute("id", id); } if (value != null) { tag.MergeAttribute("value", value.ToString()); } if (!string.IsNullOrEmpty(cssClass)) { tag.AddCssClass(cssClass); } if (!string.IsNullOrEmpty(url)) { tag.MergeAttribute("data-url", url); } if (!string.IsNullOrEmpty(param)) { tag.MergeAttribute("data-param", param); } if (!string.IsNullOrEmpty(valueField)) { tag.MergeAttribute("data-value-field", valueField); } if (!string.IsNullOrEmpty(textField)) { tag.MergeAttribute("data-text-field", textField); } if (multiple) { tag.MergeAttribute("multiple", "multiple"); } return MvcHtmlString.Create(tag.ToString()); } } } 前端再用 JS 去初始化,需要一個 utility.combobox.js 檔案:
(function ($) { //1.定義jquery的擴展方法combobox $.fn.combobox = function (options, param) { if (typeof options == 'string') { return $.fn.combobox.methods[options](this, param); } //2.將調用時候傳過來的參數和default參數合並 options = $.extend({}, $.fn.combobox.defaults, options || {}); //3.添加默認值 var target = $(this); target.attr('valuefield', options.valueField); target.attr('textfield', options.textField); target.empty(); var option = $('<option></option>'); option.attr('value', ''); option.text(options.placeholder); target.append(option); //4.判斷用戶傳過來的參數列表裡面是否包含數據data數據集,如果包含,不用發ajax從後台取,否則否送ajax從後台取數據 if (options.data) { init(target, options.data); } else { //var param = {}; options.onBeforeLoad.call(target, options.param); if (!options.url) return; if (typeof options.param == "string") { options.param = JSON.parse(options.param); } $.getJSON(options.url, options.param, function (data) { init(target, data); }); } function init(target, data) { $.each(data, function (i, item) { var option = $('<option></option>'); option.attr('value', item[options.valueField]); option.text(item[options.textField]); target.append(option); }); options.onLoadSuccess.call(target); } target.unbind("change"); target.on("change", function (e) { if (options.onChange) return options.onChange(target.val()); }); } //5.如果傳過來的是字符串,代表調用方法。 $.fn.combobox.methods = { getValue: function (jq) { return jq.val(); }, setValue: function (jq, param) { jq.val(param); }, load: function (jq, url) { $.getJSON(url, function (data) { jq.empty(); var option = $('<option></option>'); option.attr('value', ''); option.text('請選擇'); jq.append(option); $.each(data, function (i, item) { var option = $('<option></option>'); option.attr('value', item[jq.attr('valuefield')]); option.text(item[jq.attr('textfield')]); jq.append(option); }); }); } }; //6.默認參數列表 $.fn.combobox.defaults = { url: null, param: null, data: null, valueField: 'value', textField: 'text', placeholder: '請選擇', onBeforeLoad: function (param) { }, onLoadSuccess: function () { }, onChange: function (value) { } }; //這一段是新加的,在頁面初始化完成之後調用初始化方法 $(document).ready(function () { $('select').each(function () { var $combobox = $(this); $.fn.combobox.call($combobox, $combobox.data()); }) }); })(jQuery); 這個 JS 來自先前的一篇文章 https://www.jb51.net/article/92595.htm。前端呼叫如下:
<div class="col-xs-2"> @Bootstrap.SelectBox("sel", null, null, "/Home/GetDept", null, "Name", "Id") </div> 五、總結
至此,BootstrapHelper 第一個版本的封裝基本完成,主要封裝了如下幾個組件:

當然還有大家最期待的源碼分享。如果本文能幫到你,也歡迎幫忙推薦給更多需要的朋友。