在核心 MVC 中选择 ASP.NET 标记帮助程序
本文关键字：NET 帮助程序 ASP 选择 核心 MVC | 更新日期: 2023-09-27 18:29:09
我需要一些关于 ASP.NET 核心中的选择标签帮助程序的帮助。
我有一个员工列表，我正在尝试将其绑定到选择标记帮助程序。我的员工处于List<Employee> EmployeesList中，所选值将进入EmployeeId属性。我的视图模型如下所示：
public class MyViewModel
{
public int EmployeeId { get; set; }
public string Comments { get; set; }
public List<Employee> EmployeesList {get; set; }
}
我的员工班级如下所示：
public class Employee
{
public int Id { get; set; }
public string FullName { get; set; }
}
我的问题是，如何告诉我的选择标签助手在下拉列表中显示FullName时使用 Id 作为值？
<select asp-for="EmployeeId" asp-items="???" />
我将不胜感激对此的一些帮助。谢谢。
使用选择标记帮助程序呈现 SELECT 元素
在 GET 操作中，创建视图模型的对象，加载 EmployeeList 集合属性并将其发送到视图。
public IActionResult Create()
{
var vm = new MyViewModel();
vm.EmployeesList = new List<Employee>
{
new Employee { Id = 1, FullName = "Shyju" },
new Employee { Id = 2, FullName = "Bryan" }
};
return View(vm);
}
在创建视图中，从 EmployeeList 属性创建一个新的 SelectList 对象，并将其作为 asp-items 属性的值传递。
@model MyViewModel
<form asp-controller="Home" asp-action="Create">
<select asp-for="EmployeeId"
asp-items="@(new SelectList(Model.EmployeesList, nameof(Employee.Id), nameof(Employee.FullName)))">
<option>Please select one</option>
</select>
<input type="submit"/>
</form>
以及您的 HttpPost 操作方法，以接受提交的表单数据。
[HttpPost]
public IActionResult Create(MyViewModel model)
{
// check model.EmployeeId
// to do : Save and redirect
}
或
如果视图模型具有List<SelectListItem>作为下拉项的属性。
public class MyViewModel
{
public int EmployeeId { get; set; }
public string Comments { get; set; }
public List<SelectListItem> Employees { set; get; }
}
在你的行动中，
public IActionResult Create()
{
var vm = new MyViewModel();
vm.Employees = new List<SelectListItem>
{
new SelectListItem {Text = "Shyju", Value = "1"},
new SelectListItem {Text = "Sean", Value = "2"}
};
return View(vm);
}
在视图中，您可以直接将 Employees 属性用于asp-items。
@model MyViewModel
<form asp-controller="Home" asp-action="Create">
<label>Comments</label>
<input type="text" asp-for="Comments"/>
<label>Lucky Employee</label>
<select asp-for="EmployeeId" asp-items="@Model.Employees" >
<option>Please select one</option>
</select>
<input type="submit"/>
</form>
类SelectListItem属于Microsoft.AspNet.Mvc.Rendering命名空间。
确保对 select 元素使用显式结束标记。如果使用自关闭标记方法，标记帮助程序将呈现一个空的 SELECT 元素！
以下方法将不起作用
<select asp-for="EmployeeId" asp-items="@Model.Employees" />
但这将起作用。
<select asp-for="EmployeeId" asp-items="@Model.Employees"></select>
使用实体框架从数据库表中获取数据
上面的示例对选项使用硬编码项。所以我想我会添加一些示例代码来使用实体框架获取数据，因为很多人都在使用它。
假设您的 DbContext 对象具有一个名为 Employees 的属性，该属性属于 DbSet<Employee> 类型，其中Employee实体类具有如下所示的Id和Name属性
public class Employee
{
public int Id { set; get; }
public string Name { set; get; }
}
查询获取员工，并使用 LINQ 表达式中的 Select 方法为每个员工创建SelectListItem对象列表。
public IActionResult Create()
{
var vm = new MyViewModel();
vm.Employees = context.Employees
.Select(a => new SelectListItem() {
Value = a.Id.ToString(),
Text = a.Name
})
.ToList();
return View(vm);
}
假设context是数据库上下文对象。视图代码与上述相同。
使用选择列表
有些人更喜欢使用类来保存呈现选项所需的SelectList项。
public class MyViewModel
{
public int EmployeeId { get; set; }
public SelectList Employees { set; get; }
}
现在，在 GET 操作中，可以使用 SelectList 构造函数填充视图模型的 Employees 属性。请确保指定dataValueField和dataTextField参数。您可以使用 nameof 表达式静态链接字段名称。
public IActionResult Create()
{
var vm = new MyViewModel();
vm.Employees = new SelectList(GetEmployees(), nameof(Employee.Id), nameof(Employee.FirstName));
return View(vm);
}
public IEnumerable<Employee> GetEmployees()
{
// hard coded list for demo.
// You may replace with real data from database to create Employee objects
return new List<Employee>
{
new Employee { Id = 1, FirstName = "Shyju" },
new Employee { Id = 2, FirstName = "Bryan" }
};
}
在这里，我调用 GetEmployees 方法来获取 Employee 对象的列表，每个对象都有一个 Id 和 FirstName 属性，我使用这些属性作为我们创建的SelectList对象的DataValueField和DataTextField。您可以将硬编码列表更改为从数据库表中读取数据的代码。
视图代码将相同。
<select asp-for="EmployeeId" asp-items="@Model.Employees" >
<option>Please select one</option>
</select>
从字符串列表中呈现 SELECT 元素。
有时，您可能希望从字符串列表中呈现选择元素。在这种情况下，您可以使用仅需要IEnumerable<T>的 SelectList 构造函数
var vm = new MyViewModel();
var items = new List<string> {"Monday", "Tuesday", "Wednesday"};
vm.Employees = new SelectList(items);
return View(vm);
视图代码将相同。
设置所选选项
有时，您可能希望在 SELECT 元素中将一个选项设置为默认选项(例如，在编辑屏幕中，您希望加载以前保存的选项值(。为此，您只需将EmployeeId属性值设置为要选择的选项的值即可。
public IActionResult Create()
{
var vm = new MyViewModel();
vm.Employees = new List<SelectListItem>
{
new SelectListItem {Text = "Shyju", Value = "11"},
new SelectListItem {Text = "Tom", Value = "12"},
new SelectListItem {Text = "Jerry", Value = "13"}
};
vm.EmployeeId = 12; // Here you set the value
return View(vm);
}
这将在呈现页面时在选择元素中选择选项 Tom。
多选下拉列表
如果要呈现多选下拉列表，只需将视图中用于asp-for属性的视图模型属性更改为数组类型即可。
public class MyViewModel
{
public int[] EmployeeIds { get; set; }
public List<SelectListItem> Employees { set; get; }
}
这将呈现具有 multiple 属性的选择元素的 HTML 标记，这将允许用户选择多个选项。
@model MyViewModel
<select id="EmployeeIds" multiple="multiple" name="EmployeeIds">
<option>Please select one</option>
<option value="1">Shyju</option>
<option value="2">Sean</option>
</select>
在多选中设置所选选项
与单选类似，将EmployeeIds属性值设置为所需的值数组。
public IActionResult Create()
{
var vm = new MyViewModel();
vm.Employees = new List<SelectListItem>
{
new SelectListItem {Text = "Shyju", Value = "11"},
new SelectListItem {Text = "Tom", Value = "12"},
new SelectListItem {Text = "Jerry", Value = "13"}
};
vm.EmployeeIds= new int[] { 12,13} ;
return View(vm);
}
这将在呈现页面时在多选元素中选择选项 Tom 和 Jerry。
使用 ViewBag 传输项目列表
如果不希望保留集合类型属性以将选项列表传递到视图，则可以使用动态 ViewBag 执行此操作。(这不是我个人推荐的方法，因为viewbag是动态的，你的代码容易出现未捕获的错别字错误(
public IActionResult Create()
{
ViewBag.Employees = new List<SelectListItem>
{
new SelectListItem {Text = "Shyju", Value = "1"},
new SelectListItem {Text = "Sean", Value = "2"}
};
return View(new MyViewModel());
}
并在视图中
<select asp-for="EmployeeId" asp-items="@ViewBag.Employees">
<option>Please select one</option>
</select>
使用 ViewBag 传输项目列表并设置所选选项
同上。您所要做的就是将属性(要为其绑定下拉列表(值设置为要选择的选项的值。
public IActionResult Create()
{
ViewBag.Employees = new List<SelectListItem>
{
new SelectListItem {Text = "Shyju", Value = "1"},
new SelectListItem {Text = "Bryan", Value = "2"},
new SelectListItem {Text = "Sean", Value = "3"}
};
vm.EmployeeId = 2; // This will set Bryan as selected
return View(new MyViewModel());
}
并在视图中
<select asp-for="EmployeeId" asp-items="@ViewBag.Employees">
<option>Please select one</option>
</select>
对项目进行分组
选择标记帮助程序方法支持在下拉列表中对选项进行分组。您所要做的就是在操作方法中指定每个SelectListItem的Group属性值。
public IActionResult Create()
{
var vm = new MyViewModel();
var group1 = new SelectListGroup { Name = "Dev Team" };
var group2 = new SelectListGroup { Name = "QA Team" };
var employeeList = new List<SelectListItem>()
{
new SelectListItem() { Value = "1", Text = "Shyju", Group = group1 },
new SelectListItem() { Value = "2", Text = "Bryan", Group = group1 },
new SelectListItem() { Value = "3", Text = "Kevin", Group = group2 },
new SelectListItem() { Value = "4", Text = "Alex", Group = group2 }
};
vm.Employees = employeeList;
return View(vm);
}
视图代码没有变化。 选择标记帮助程序现在将呈现 2 个 OptGroup 项目中的选项。
我为此创建了一个接口和一个<options>标签助手。因此，我不必在每次必须填充<select>控件时都将IEnumerable<T>项转换为IEnumerable<SelectListItem>。
而且我认为它工作得很好...
用法如下：
<select asp-for="EmployeeId">
<option value="">Please select...</option>
<options asp-items="@Model.EmployeesList" />
</select>
要使其与标记帮助程序一起使用，您必须在类中实现该接口：
public class Employee : IIntegerListItem
{
public int Id { get; set; }
public string FullName { get; set; }
public int Value { return Id; }
public string Text{ return FullName ; }
}
这些是所需的代码：
界面：
public interface IIntegerListItem
{
int Value { get; }
string Text { get; }
}
<options>标记帮助程序：
[HtmlTargetElement("options", Attributes = "asp-items")]
public class OptionsTagHelper : TagHelper
{
public OptionsTagHelper(IHtmlGenerator generator)
{
Generator = generator;
}
[HtmlAttributeNotBound]
public IHtmlGenerator Generator { get; set; }
[HtmlAttributeName("asp-items")]
public object Items { get; set; }
public override void Process(TagHelperContext context, TagHelperOutput output)
{
output.SuppressOutput();
// Is this <options /> element a child of a <select/> element the SelectTagHelper targeted?
object formDataEntry;
context.Items.TryGetValue(typeof(SelectTagHelper), out formDataEntry);
var selectedValues = formDataEntry as ICollection<string>;
var encodedValues = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
if (selectedValues != null && selectedValues.Count != 0)
{
foreach (var selectedValue in selectedValues)
{
encodedValues.Add(Generator.Encode(selectedValue));
}
}
IEnumerable<SelectListItem> items = null;
if (Items != null)
{
if (Items is IEnumerable)
{
var enumerable = Items as IEnumerable;
if (Items is IEnumerable<SelectListItem>)
items = Items as IEnumerable<SelectListItem>;
else if (Items is IEnumerable<IIntegerListItem>)
items = ((IEnumerable<IIntegerListItem>)Items).Select(x => new SelectListItem() { Selected = false, Value = ((IIntegerListItem)x).Value.ToString(), Text = ((IIntegerListItem)x).Text });
else
throw new InvalidOperationException(string.Format("The {2} was unable to provide metadata about '{1}' expression value '{3}' for <options>.",
"<options>",
"ForAttributeName",
nameof(IModelMetadataProvider),
"For.Name"));
}
else
{
throw new InvalidOperationException("Invalid items for <options>");
}
foreach (var item in items)
{
bool selected = (selectedValues != null && selectedValues.Contains(item.Value)) || encodedValues.Contains(item.Value);
var selectedAttr = selected ? "selected='selected'" : "";
if (item.Value != null)
output.Content.AppendHtml($"<option value='{item.Value}' {selectedAttr}>{item.Text}</option>");
else
output.Content.AppendHtml($"<option>{item.Text}</option>");
}
}
}
}
可能会有一些错别字，但我认为目标很明确。我不得不编辑一点。
我下面的回答并没有解决问题，但它与问题有关。
如果有人使用enum类模型而不是类模型，如以下示例所示：
public enum Counter
{
[Display(Name = "Number 1")]
No1 = 1,
[Display(Name = "Number 2")]
No2 = 2,
[Display(Name = "Number 3")]
No3 = 3
}
以及提交时获取值的属性：
public int No { get; set; }
在 Razor 页面中，可以使用 Html.GetEnumSelectList<Counter>() 获取枚举属性。
<select asp-for="No" asp-items="@Html.GetEnumSelectList<Counter>()"></select>
它生成以下 HTML：
<select id="No" name="No">
<option value="1">Number 1</option>
<option value="2">Number 2</option>
<option value="3">Number 3</option>
</select>
您也可以使用 IHtmlHelper.GetEnumSelectList。
// Summary:
// Returns a select list for the given TEnum.
//
// Type parameters:
// TEnum:
// Type to generate a select list for.
//
// Returns:
// An System.Collections.Generic.IEnumerable`1 containing the select list for the
// given TEnum.
//
// Exceptions:
// T:System.ArgumentException:
// Thrown if TEnum is not an System.Enum or if it has a System.FlagsAttribute.
IEnumerable<SelectListItem> GetEnumSelectList<TEnum>() where TEnum : struct;
您可以使用以下代码进行多项选择：
<select asp-for="EmployeeId" multiple="multiple" asp-items="@ViewBag.Employees">
<option>Please select</option>
</select>
您还可以使用：
<select id="EmployeeId" name="EmployeeId" multiple="multiple" asp-items="@ViewBag.Employees">
<option>Please select</option>
</select>
在 Get 中：
public IActionResult Create()
{
ViewData["Tags"] = new SelectList(_context.Tags, "Id", "Name");
return View();
}
在帖子中：
var selectedIds= Request.Form["Tags"];
在视图 ：
<label>Tags</label>
<select asp-for="Tags" id="Tags" name="Tags" class="form-control" asp-items="ViewBag.Tags" multiple></select>
asp-items需要一些SelectListItem包含Text和Value属性的类(来自命名空间 Microsoft.AspNetCore.Mvc.Rendering(的实例集合。因此，您可以将员工集合转换为所需的 f.e. employees.Select(e => new SelectListItem(e.FullName, e.Id.ToString()))并将结果放入asp-items属性。