.Net Core使用视图组件(ViewComponent)封装表单文本框控件

实例程序的界面效果如下图所示:

在表单中的搜索条件有姓名,学号,成绩。他们在一行中按照水平三等分排列。

.Net Core使用视图组件(ViewComponent)封装表单文本框控件

在cshtml中用html实现上述表单效果的的代码如下:

 <form class="form-horizontal" role="form">
<div class="row">
<div class="form-group col-md-4">
<label for="name" class="col-md-2 control-label">姓名</label>
<div class="col-md-10">
<input type="text" class="form-control" id="name" placeholder="请输姓名">
</div>
</div>
<div class="form-group col-md-4">
<label for="name" class="col-md-2 control-label">学号</label>
<div class="col-md-10">
<input type="text" class="form-control" id="name" placeholder="请输学号">
</div>
</div>
<div class="form-group col-md-4">
<label for="name" class="col-md-2 control-label">成绩</label>
<div class="col-md-10">
<input type="text" class="form-control" id="name" placeholder="请输成绩">
</div>
</div>
</div>
<button type="submit" class="btn btn-default">搜索</button>
</form>

通过观察上述代码发现,搜索条件按照水平三等分排列会产生如下图红线标记的冗余代码:

.Net Core使用视图组件(ViewComponent)封装表单文本框控件

通过截图可以看出,是否可以把这个div块封装成一个控件,这样就不用重复写样式属性,在使用时就只给lable,input控件根据实际情况赋予其相应的属性。

在.Net Core中视图组件(ViewComponent)可以完成这一功能。视图组件类似于部分视图,但是它们更强大。视图组件不使用模型绑定,只依赖于调用时提供的数据。

微软的官方帮助文档地址为:https://docs.microsoft.com/en-us/aspnet/core/mvc/views/view-components?view=aspnetcore-2.2

创建视图组件(ViewComponent)

1.在解决方案根目录下创建ViewComponents文件夹,

   在ViewComponents文件夹下在添加子文件夹InputLabelTextBox,

   InputLabelTextBox文件夹下分别添加l类InputLabelTextBoxViewComponent.cs和InputLabelTextBoxViewModel.cs 结果如下图所示:

  .Net Core使用视图组件(ViewComponent)封装表单文本框控件

InputLabelTextBoxViewComponent.cs为视图组件类

     public class InputLabelTextBoxViewComponent : ViewComponent
{
public IViewComponentResult Invoke(string labelText, string inputId,
string placehodler, string viewName)
{
//没有指定视图名称,默认使用Default.cshtml
if (string.IsNullOrEmpty(viewName))
{
viewName = "Default";
}
var fortmatDataViewModel = new InputLabelTextBoxViewModel(labelText, inputId, placehodler, viewName);
return View(viewName, fortmatDataViewModel);
}
}

InputLabelTextBoxViewModel.cs为视图组件中所用到的属性类,

     public class InputLabelTextBoxViewModel
{
/// <summary>
/// Label控件的文本
/// </summary>
public string LabelText { get; set; } /// <summary>
/// Input控件的Id
/// </summary>
public string InputId { get; set; } /// <summary>
/// Input控件的水印
/// </summary>
public string Placeholder { get; set; } /// <summary>
/// 视图名称
/// </summary>
public string ViewName { get; set; } public InputLabelTextBoxViewModel(string labelText, string inputId, string placeholder, string viewName)
{
LabelText = string.IsNullOrEmpty(labelText) ? "" : labelText;
InputId = string.IsNullOrEmpty(inputId) ? "" : inputId;
Placeholder = string.IsNullOrEmpty(placeholder) ? "" : placeholder;
ViewName = string.IsNullOrEmpty(viewName) ? "" : viewName;
}
}

2.在解决方案的Views文件夹下的Shared文件夹中添加Components子文件夹,

   在Components文件夹下在添加其子文件夹InputLabelTextBox,

   在文件夹中添加Default.cshtml视图,结果如下图所示:

.Net Core使用视图组件(ViewComponent)封装表单文本框控件

Default.cshtml就是InputLabelTextBoxViewComponent.cs在界面上默认对应的视图。

 @using TestViewComponent.ViewComponents
@model InputLabelTextBoxViewModel <div class="form-group col-md-4">
<label for="name" class="col-md-2 control-label">@Model.LabelText</label>
<div class="col-md-10">
<input type="text" class="form-control" id="@Model.InputId" placeholder="@Model.Placeholder">
</div>
</div>

在About.cshtml页面中引用控件。

 @{
ViewData["Title"] = "About";
}
<!--引入命名空间-->
@using TestViewComponent.ViewComponents
<h2>分布视图实例:</h2>
<form class="form-horizontal" role="form">
<div class="row">
<!--使用类型创建-->
@await Component.InvokeAsync(typeof(InputLabelTextBoxViewComponent), new {
LabelText = "姓名",
InputId = "InputName",
Placeholder = "请输入姓名...",
})
<!--InputLabelTextBox为InputLabelTextBoxViewComponent.cs去掉ViewComponent后的名字-->
@await Component.InvokeAsync("InputLabelTextBox", new
{
LabelText = "姓名1",
InputId = "InputName1",
Placeholder = "请输入姓名...",
})
</div>
</form>

运行后的效果如图所示:

.Net Core使用视图组件(ViewComponent)封装表单文本框控件

微软官方文档提供了调用视图组建两个方法,已经在上述代码中加以注释说明。

.Net Core使用视图组件(ViewComponent)封装表单文本框控件

3.InputLabelTextBoxViewComponent对应多个cshtml页面

在上述例子中,InputLabelTextBoxViewComponent默认对应于Default.cshtml,现在又想创建第二个视图对应于InputLabelTextBoxViewComponent该怎么处理?

首先在InputLabelTextBox文件夹下创建DefaultOne.cshtml页面。

然后在调用视图组建时,把InputLabelTextBoxViewModel的ViewName属性的值赋成DefaultOne,这样在页面用引用的控件就对应于DefaultOne.cshtml。

源代码下载地址 : https://files-cdn.cnblogs.com/files/fengye310/DotNetCoreDemo.zip

上一篇:pytorch使用tensorboardX进行loss可视化


下一篇:py文件的运行