HtmlHelper.ListBox 方法 (String, String, IEnumerable<SelectListItem>, Object, Int32, Boolean, Object)

傳回 HTML 清單方塊控制項,此控制項含有指定的名稱、大小、透過屬性物件定義的自訂屬性、項目、預設項目及選取項目,並指定是否已啟用多個選取項目。

命名空間:  System.Web.WebPages.Html
組件:  System.Web.WebPages (在 System.Web.WebPages.dll 中)

public IHtmlString ListBox(
	string name,
	string defaultOption,
	IEnumerable<SelectListItem> selectList,
	Object selectedValues,
	int size,
	bool allowMultiple,
	Object htmlAttributes
)

參數

name
型別:System.String

指派給 HTML select 項目之 name 屬性的值。

defaultOption
型別:System.String

要針對清單中預設選項顯示的文字。

selectList
型別:System.Collections.Generic.IEnumerable<SelectListItem>

用來填入清單的 SelectListItem 執行個體清單。

selectedValues
型別:System.Object

用以指定清單中預設選取之項目的物件。這些選取項目是藉由檢查物件之屬性,透過反映所擷取而來。

size
型別:System.Int32

指派給項目 size 屬性的值。

allowMultiple
型別:System.Boolean

true 表示已啟用多個選取項目,否則為 false

htmlAttributes
型別:System.Object

包含元素之自訂屬性的物件。這些屬性 (Attribute) 名稱和值是藉由檢查物件之屬性 (Property),透過反映所擷取而來。

傳回值

型別:System.Web.IHtmlString
代表清單方塊控制項的 HTML 標記。

例外狀況條件
ArgumentException

namenull 或空白。

傳回的標記是由下列形式的 HTML select 項目所組成:

<select name="name" size="size" multiple="multiple" ...htmlAttributes...>
  <option>defaultOption</option>
  <option value="selectList[0].Value" selected="selected">selectList[0].Text</option>
  <option value="selectList[1].Value">selectList[1].Text</option>
  ...
</select>

allowMultipletrue

<select name="name" size="size" ...htmlAttributes...>
  <option>defaultOption</option>
  <option value="selectList[0].Value" selected="selected">selectList[0].Text</option>
  <option value="selectList[1].Value">selectList[1].Text</option>
  ...
</select>

allowMultiplefalse

當清單項目的值或它的顯示文字 (如果此元素沒有值) 符合其中一個 selectedValues 的屬性時,則會選取該清單項目。選取項目時,即會將相關聯 HTML option 元素的 selected 屬性設定為 selected

size 屬性會指定可在清單方塊中看見的清單項目數。如果 size 大於 1 且可使用的項目比顯示的項目還多時,清單方塊會顯示捲軸。

顯示: