将 Spark 视图渲染为字符串

Question

我正在尝试将部分视图呈现为字符串，以便它可以作为 HTML 返回到 jquery ajax 调用。经过大量搜索，我找到了这段代码。

public string RenderAsString(string viewName, string modelName, object model)
{
    // Set up your spark engine goodness.
    var settings = new SparkSettings().SetPageBaseType(typeof(SparkView));
    var templates = new FileSystemViewFolder(Server.MapPath("~/Views"));
    var engine = new SparkViewEngine(settings) { ViewFolder = templates };


    // "Describe" the view (the template, it is a template after all), and its details.
    var descriptor = new SparkViewDescriptor().AddTemplate(@"Shared\" + viewName + ".spark");

    // Create a spark view engine instance
    var view = (SparkView)engine.CreateInstance(descriptor);

    // Add the model to the view data for the view to use.
    view.ViewData[modelName] = model;

    // Render the view to a text writer.
    var writer = new StringWriter(); view.RenderView(writer);

    // Convert to string
    return writer.ToString();
}

但是当执行以下行时：

var view = (SparkView)engine.CreateInstance(descriptor);

我收到以下错误：

动态视图编译失败。一个 需要对象引用 非静态字段、方法或属性 'DomainModel.Entities.Region.Id.get。

这是我的部分观点：

<ViewData Model="Region" />

<div id="${ Region.Id }" class="active-translation-region-widget" >
    <label>${Region.RegionName}</label>
        ${ Html.CheckBox("Active") }
</div> 

它似乎无法识别该模型。

PS 当我像这样从父视图调用视图时，

<for each="var region in Model">
    <ActiveTranslationRegion Region="region" if="region.Active==true"></ActiveTranslationRegion>
</for>

它会完美呈现。我做错了什么？

Answer 1

仅从外观上看，我认为以下行是问题所在：

<ViewData Model="Region" />

相反，它应该显示为：

<viewata model="Region" />

注意小写的“模型”。这是因为 model 是一种特殊情况，因为它在幕后执行到强类型视图模型的转换。最上面的一个将在生成的视图类中定义一个名为 Model 的变量，并将值 Region 分配给它。使用下面的小写选项实际上会创建一个 Model 变量，但也会将其转换为来自 ViewData 字典的 Region 强类型实例。

注意 当在代码中使用 Model 时，就像您在 foreach 循环中所做的那样，它需要是大写，这在您的代码中是正确的案件。再次强调，这是唯一的特殊情况，因为它从 ViewData 字典中提取强类型模型。

另一件事 - 必须在父视图中声明，并且每个页面只能定义一次，因此您不能在分部视图中重新定义它。如果它是部分视图，您应该通过传递模型的一部分来使用它，就像上面第二个示例中所做的那样。

上述异常的原因是因为它试图将 Id 属性作为 Region Type 的静态项获取，而不是查询 <作为视图模型一部分的 Region 实例 上的 code>Id 属性。

附带说明一下，到达您想要的位置的代码有点混乱。您可以通过查看一些 直接使用示例，但我知道这可能只是看到它工作的一个峰值...:)

更新以响应您的跟进问题/答案

我相当确定问题出在传递 Region 上 进入以下调用：

<ActiveTranslationRegion Region="region" if="region.Active==true">

... 再次归结为命名。是的，正如我之前所说，每个视图只能有一个模型，因此您需要做的是从部分顶部删除以下内容：

<viewdata model="Region" />

这就是导致问题的原因。然后，我将像这样重命名进入您的部分的项目：

<ActiveTranslationRegion ActiveRegion="region" if="region.Active==true">

然后您的部分将如下所示：

<form action="/Translation/DeactivateRegion" class="ui-widget-content active-translation-region-widget">
    <input type="hidden" name="Id" value="${ActiveRegion.Id}" />        
    <label class="region-name">${ ActiveRegion.RegionName }</label>
    <input class="deactivate-region-button" type="image" src=${Url.Content("~/Content/Images/Deactivate.png")} alt="Deactivate" />
</form>

注意我使用ActiveRegion因为在Spark解析器中，ActiveRegion 被声明为变量，并在循环 for 循环 时分配当前作用域中 region 的值。无需严格遵守模型 - 因为您已经将模型的一部分传递给了您已声明为ActiveRegion。哦，如果您确实愿意，您可以坚持使用名称 Region，我只是更改它来表明观点，因为您有一个名为 的 Type Region 在你的代码中，我不太喜欢使用与类型相同的变量名称可能带来的奇怪问题。另外，它使它更清晰一些。

调用 Html.RenderPartial 方法的缺点并不是立即显而易见的。您失去的一件事是 Spark 提供的 3 遍渲染。如果您使用标签语法（这是更好的），您将能够将部分中的部分堆叠到多个级别，向下传递变量，为每个部分提供它们需要的堆栈。它变得真正强大 - 开始思考数据网格类型结构，其中行和单元格是单独的部分，它们从模型中获取所需的变量，所有这些都在单独的可管理视图文件中保持良好和干净。但不要就此止步，开始考虑基于变量或三列布局来定位页眉和页脚内容，这些布局创建一个仪表板，在多个深度的单独堆叠的部分上呈现各种类型。

当您使用沼泽标准 ASP.NET MVC Helper 方法 Html.RenderPartial() 时，您会失去所有灵活性 - 小心这样做，很可能有像上面这样的解决方案。

让我知道这是否有效...
一切顺利
罗布·G

Answer 2

我对代码和视图进行了相当多的重构。最后，我真正想要实现的是有一个父视图（未显示）迭代 IEnumerable 并为每次迭代渲染一个部分视图（ActiveTranslationRegion），它渲染一些 Html 来表示区域模型。

我还希望能够通过 ajax 调用来调用操作方法，以通过向其传递单独的区域模型来呈现单独的 ActiveTranslationRegion 部分视图。我相应地重构了代码。

部分视图 (_ActiveTranslationRegion.spark)

<viewdata model="Region" />

<form action="/Translation/DeactivateRegion" class="ui-widget-content active-translation-region-widget">
    <input type="hidden" name="Id" value="${Model.Id}" />        
    <label class="region-name">${ Model.RegionName }</label>
    <input class="deactivate-region-button" type="image" src=${Url.Content("~/Content/Images/Deactivate.png")} alt="Deactivate" />
</form>

请注意，通过使用我可以按照 RobertTheGrey 建议的方式引用视图中的模型（见上文）。

我删除了所有代码以将视图作为字符串返回，并简单地创建了一个返回partialViewResult的操作方法方法：

[UnitOfWork]
public PartialViewResult ActivateRegion(int id)
{
    var region = _repos.Get(id);
    if (region != null)
    {    
        region.Active = true;
        _repos.SaveOrUpdate(region);
    }

    return PartialView("_ActiveTranslationRegion", region);
}

我必须做的一件事是修改我的父视图，使其看起来像这样：

<div id="inactive-translation-regions-panel">
    <h3 class="ui-widget-header">Inactive Regions</h3>
    <for each="var region in Model">
        <span if="region.Active==false">
                # Html.RenderPartial("_InActiveTranslationRegion", region);
        </span>
    </for>
</div>

以前我有以下内容：

<div id="inactive-translation-regions-panel">
   <for each="var region in Model">
          <ActiveTranslationRegion Region="region" if="region.Active==true"></ActiveTranslationRegion>
   </for>
</div>

注意我有调用 Html.RenderPartial 而不是使用该元素。如果我尝试使用该元素（我更愿意这样做），我会收到以下错误：

Only one viewdata model can be declared. IEnumerable<Region> != Region

有解决该问题的方法吗？

更新：

我尝试了你的建议，但没有成功。回顾一下这个问题，我想在两种不同的情况下使用部分。在第一个实例中，我有一个使用 IEnumerable 模型的父视图，部分仅使用 Region 作为其模型。因此，在父级中，我迭代 IEnumerable 并将 Region 传递给部分。在第二个实例中，我想从操作方法调用 PartialView("_ActiveTranslationRegion", region) 。如果我从部分中删除 ，我会收到有关模型的错误消息。解决我发现的问题的最佳方法是将绑定添加到 bindings.xml 文件：

<element name="partial"># Html.RenderPartial("@name", @model);</element>

（注意：将绑定文件中的此条目全部保留在同一行似乎非常重要）

我仍然可以如上所述从操作方法中调用部分，并将其传递为区域作为模型，但我也可以用更像“html”的标签替换父视图中对 Html.RenderPartial 的调用：

<partial name="_ActiveTranslationRegion" model="region" />

所以我的父级现在的视图看起来更像是这样的：

<div id="inactive-translation-regions-panel">
    <h3 class="ui-widget-header">Inactive Regions</h3>
    <for each="var region in Model">
        <span if="region.Active==false">
               <partial name="_ActiveTranslationRegion" model="region" />
        </span>
    </for>
</div>

当然，在幕后它仍在调用

# Html.RenderPartial("_ActiveTranslationRegion", region);

但它是我们能想到的最佳解决方案。

问候，
西蒙