如何为 DisplayFor() 创建 MVC Razor 模板

Question

我的视图模型中有几个属性仅用于显示，但我需要使用 jQuery 检索它们的值以在页面上执行计算。 标准的Html.DisplayFor()方法只是将它们的值写入页面。 我想创建一个剃刀模板，允许我将每个元素呈现为：

<span id="ElementsId">Element's value</span>

我知道我可以在Html.DisplayFor() 中指定一个模板来使用特定模板来呈现属性，但在该模板中我如何识别要写入span标签的id属性？

@Html.DisplayFor(model => model.Element, "MyTemplate");

Answer 1

好的，我找到了，其实很简单。 在我的Views\\Shared\\DisplayTemplates文件夹中，我有包含以下内容的Reading.cshtml ：

@model System.Int32
<span id="@ViewData.ModelMetadata.PropertyName">@Model</span>

这使用属性名称作为id属性和属性值作为内容呈现正确的标签：

<span id="Reading">1234</span>

在视图文件中，可以使用以下命令调用它：

@Html.DisplayFor(model => model.Reading, "Reading")

或者，如果模型属性使用UIHint("Reading")装饰，则模板名称可以不包含在DisplayFor()调用之外，它仍将使用模板进行渲染：

@Html.DisplayFor(model => model.Reading)

这应该同样适用于自定义编辑器模板。

Answer 2

我阅读了许多关于为布尔属性定义@Html.DisplayFor模板的 SO 帖子，但我无法清楚地理解它们。 您的问题就此结束，在掌握了它之后，我决定添加一个新答案，包括实现该问题所需的所有步骤。 它可能对其他人有帮助。

1. 创建模板

首先需要在下面的路径中添加一个Partial View （路径很重要）：

Views/Shared/DisplayTemplates/

例如，我创建了一个名为_ElementTemplate的Partial View并像这样填充它：

<span>
    @(@Model ? "Yes" : "No")
</span>

2. 在模型中添加UIHint

要在您的property和template之间建立连接，您应该在模型类中添加如下所示的UIHint属性：

[UIHint("_YesOrNoTemplate")]
public bool MyProperty { get; set; }

3.在视图中使用@Html.DisplayNameFor

在您需要此属性的每个视图中，您可以使用以下代码：

<div>
    @Html.DisplayFor(modelItem => item.MyProperty)
</div>

输出

上面的代码在我的示例中呈现为下面的代码（ if (MyProperty == true) ）：

<div>
    <span>
        Yes
    </span>
</div>

设置属性

要设置id或其他 html 属性，您可以像这样使用ModelMetadata ：

<span id="@ViewData.ModelMetadata.PropertyName">
    @(@Model ? "Yes" : "No")
</span>

带属性的输出

<div id="MyProperty">
    <span>
        Yes
    </span>
</div>

Answer 3

您可以将此id视图模型的一部分并在显示模板中使用它：

<span id="@Model.Id">@Html.DisplayFor(x => x.Value)</span>

Answer 4

有一篇文章解释了 Razor 中的Templates （显示 + 编辑器）以及UIHint属性。

Answer 5

我遇到了与原始帖子完全相同的问题。

不确定最后一条评论是否有效。 它会使 HTML id 属性成为运行时值，因此不能用设计时名称引用。

我使用了 DisplayFor 的重载，它允许您将新对象添加到数据字典 (ViewBag)

我的模型是一个名为 Project 的 C# 对象，具有各种属性。 在我看来，我有这个：

@Html.DisplayFor(model => model.ProjectName, "StringDisplaySetHtmlID", new { HtmlID = "project-name" })

这是使用一个名为 StringDisplaySetHtmlID 的自定义模板，最后一个参数将一个键值对添加到 Viewbag。

我的模板文件如下所示：

@model string
<span class = "display-field" id = "@(ViewBag.HtmlID)">@Model</span> 

我还在此处设置了一个用于样式目的的类。 我使用了键名 HtmlID 而不仅仅是 ID 来避免潜在的常见命名冲突。

现在在我的 javascript 中，我可以使用以下 jquery 获取 span 的内容：

var projectName = $('#project-name').text()

Answer 6

构建将输出以下内容的显示模板的最佳方法：

<span id="ElementsId">Element's value</span>

会是这样：

<span id="@Html.IdForModel()">@Html.DisplayTextFor(m => m)</span>

首次发布此问题时，这些助手可能还不存在，但这以大卫的回答为基础，有两种方式：

1. 使用@Html.DisplayTextFor(m => m)而不是@Model仍然会在呈现值时使用数据注释，而不是仅仅在其上运行ToString() 。
2. 在模型嵌套或重复的情况下，使用@Html.IdForModel()而不是@ViewData.ModelMetadata.PropertyName会更可取，并且 ID 不会只是属性名称。