Razor View Engineを使用して部分ビューASP.NET MVC 3から特定のセクションにコンテンツを挿入する
このセクションは私の_Layout.cshtmlで定義しています
@RenderSection("Scripts", false)
私はビューからそれを簡単に使うことができます：
@section Scripts {
@*Stuff comes here*@
}
私が苦労しているのは、部分的なビューからこのセクション内にコンテンツを挿入する方法です。
これが私のビューページだとしましょう。
@section Scripts {
<script>
//code comes here
</script>
}
<div>
poo bar poo
</div>
<div>
@Html.Partial("_myPartial")
</div>
_myPartial部分ビューからScriptsセクション内にコンテンツを注入する必要があります。
これどうやってするの？
セクションは部分ビューでは機能しません。これは仕様によるものです。似たような振る舞いをさせるために カスタムヘルパー を使うこともできますが、正直なところパーシャルの責任ではなく必要なスクリプトを含めるのがビューの責任です。これを行うにはメインビューの@scriptsセクションを使用することをお勧めします。スクリプトについてのパーシャルは心配ありません。
これは非常に人気のある質問ですので、私は自分の解決策を投稿します。
私も同じ問題を抱えていましたが、それは理想的ではありませんが、実際には非常にうまく機能し、部分的な依存関係をビューに依存させないと思います。
私のシナリオでは、アクションはそれ自体でアクセス可能でしたが、ビュー（Googleマップ）に埋め込むこともできました。
私の_layoutには、
@RenderSection("body_scripts", false)
私のindexビューで私は持っています：
@Html.Partial("Clients")
@section body_scripts
{
@Html.Partial("Clients_Scripts")
}
私のclientsビューで私は持っています（すべてのマップとassoc.html）：
@section body_scripts
{
@Html.Partial("Clients_Scripts")
}
私のClients_Scriptsビューには、ページにレンダリングされるJavaScriptが含まれています
このようにして私のスクリプトは分離され、必要に応じてページにレンダリングすることができます。body_scriptsタグは、剃刀ビューエンジンが最初に見つけたときにのみレンダリングされます。
それは私がすべてを分離することを可能にします - それは私のために非常にうまくいく解決策です、他のものはそれに関して問題を抱えるかもしれません、しかしそれは「設計による」穴にパッチを当てます。
このスレッドの解決策 から、usingブロック内のhtml（スクリプトも）のレンダリングを遅らせることを可能にする、次のような複雑すぎる解決策を思いついた。
使用法
「セクション」を作成
典型的なシナリオ：部分的ビューでは、部分的ビューがページ内で何回繰り返されても、ブロックを1回だけインクルードします。
@using (Html.Delayed(isOnlyOne: "some unique name for this section")) { <script> someInlineScript(); </script> }パーシャルビューでは、パーシャルが使用されるたびにブロックを含めます。
@using (Html.Delayed()) { <b>show me multiple times, @Model.Whatever</b> }パーシャルビューでは、パーシャルが繰り返される回数に関係なく、ブロックを1回だけインクルードしますが、後で
when-i-call-youという名前で明示的にレンダリングします。@using (Html.Delayed("when-i-call-you", isOnlyOne: "different unique name")) { <b>show me once by name</b> <span>@Model.First().Value</span> }
「セクション」をレンダリングする
（つまり、親ビューに遅延セクションを表示する）
@Html.RenderDelayed(); // writes unnamed sections (#1 and #2, excluding #3)
@Html.RenderDelayed("when-i-call-you", false); // writes the specified block, and ignore the `isOnlyOne` setting so we can dump it again
@Html.RenderDelayed("when-i-call-you"); // render the specified block by name
@Html.RenderDelayed("when-i-call-you"); // since it was "popped" in the last call, won't render anything due to `isOnlyOne` provided in `Html.Delayed`
コード
public static class HtmlRenderExtensions {
/// <summary>
/// Delegate script/resource/etc injection until the end of the page
/// <para>@via https://stackoverflow.com/a/14127332/1037948 and http://jadnb.wordpress.com/2011/02/16/rendering-scripts-from-partial-views-at-the-end-in-mvc/ </para>
/// </summary>
private class DelayedInjectionBlock : IDisposable {
/// <summary>
/// Unique internal storage key
/// </summary>
private const string CACHE_KEY = "DCCF8C78-2E36-4567-B0CF-FE052ACCE309"; // "DelayedInjectionBlocks";
/// <summary>
/// Internal storage identifier for remembering unique/isOnlyOne items
/// </summary>
private const string UNIQUE_IDENTIFIER_KEY = CACHE_KEY;
/// <summary>
/// What to use as internal storage identifier if no identifier provided (since we can't use null as key)
/// </summary>
private const string EMPTY_IDENTIFIER = "";
/// <summary>
/// Retrieve a context-aware list of cached output delegates from the given helper; uses the helper's context rather than singleton HttpContext.Current.Items
/// </summary>
/// <param name="helper">the helper from which we use the context</param>
/// <param name="identifier">optional unique sub-identifier for a given injection block</param>
/// <returns>list of delayed-execution callbacks to render internal content</returns>
public static Queue<string> GetQueue(HtmlHelper helper, string identifier = null) {
return _GetOrSet(helper, new Queue<string>(), identifier ?? EMPTY_IDENTIFIER);
}
/// <summary>
/// Retrieve a context-aware list of cached output delegates from the given helper; uses the helper's context rather than singleton HttpContext.Current.Items
/// </summary>
/// <param name="helper">the helper from which we use the context</param>
/// <param name="defaultValue">the default value to return if the cached item isn't found or isn't the expected type; can also be used to set with an arbitrary value</param>
/// <param name="identifier">optional unique sub-identifier for a given injection block</param>
/// <returns>list of delayed-execution callbacks to render internal content</returns>
private static T _GetOrSet<T>(HtmlHelper helper, T defaultValue, string identifier = EMPTY_IDENTIFIER) where T : class {
var storage = GetStorage(helper);
// return the stored item, or set it if it does not exist
return (T) (storage.ContainsKey(identifier) ? storage[identifier] : (storage[identifier] = defaultValue));
}
/// <summary>
/// Get the storage, but if it doesn't exist or isn't the expected type, then create a new "bucket"
/// </summary>
/// <param name="helper"></param>
/// <returns></returns>
public static Dictionary<string, object> GetStorage(HtmlHelper helper) {
var storage = helper.ViewContext.HttpContext.Items[CACHE_KEY] as Dictionary<string, object>;
if (storage == null) helper.ViewContext.HttpContext.Items[CACHE_KEY] = (storage = new Dictionary<string, object>());
return storage;
}
private readonly HtmlHelper helper;
private readonly string identifier;
private readonly string isOnlyOne;
/// <summary>
/// Create a new using block from the given helper (used for trapping appropriate context)
/// </summary>
/// <param name="helper">the helper from which we use the context</param>
/// <param name="identifier">optional unique identifier to specify one or many injection blocks</param>
/// <param name="isOnlyOne">extra identifier used to ensure that this item is only added once; if provided, content should only appear once in the page (i.e. only the first block called for this identifier is used)</param>
public DelayedInjectionBlock(HtmlHelper helper, string identifier = null, string isOnlyOne = null) {
this.helper = helper;
// start a new writing context
((WebViewPage)this.helper.ViewDataContainer).OutputStack.Push(new StringWriter());
this.identifier = identifier ?? EMPTY_IDENTIFIER;
this.isOnlyOne = isOnlyOne;
}
/// <summary>
/// Append the internal content to the context's cached list of output delegates
/// </summary>
public void Dispose() {
// render the internal content of the injection block helper
// make sure to pop from the stack rather than just render from the Writer
// so it will remove it from regular rendering
var content = ((WebViewPage)this.helper.ViewDataContainer).OutputStack;
var renderedContent = content.Count == 0 ? string.Empty : content.Pop().ToString();
// if we only want one, remove the existing
var queue = GetQueue(this.helper, this.identifier);
// get the index of the existing item from the alternate storage
var existingIdentifiers = _GetOrSet(this.helper, new Dictionary<string, int>(), UNIQUE_IDENTIFIER_KEY);
// only save the result if this isn't meant to be unique, or
// if it's supposed to be unique and we haven't encountered this identifier before
if( null == this.isOnlyOne || !existingIdentifiers.ContainsKey(this.isOnlyOne) ) {
// remove the new writing context we created for this block
// and save the output to the queue for later
queue.Enqueue(renderedContent);
// only remember this if supposed to
if(null != this.isOnlyOne) existingIdentifiers[this.isOnlyOne] = queue.Count; // save the index, so we could remove it directly (if we want to use the last instance of the block rather than the first)
}
}
}
/// <summary>
/// <para>Start a delayed-execution block of output -- this will be rendered/printed on the next call to <see cref="RenderDelayed"/>.</para>
/// <para>
/// <example>
/// Print once in "default block" (usually rendered at end via <code>@Html.RenderDelayed()</code>). Code:
/// <code>
/// @using (Html.Delayed()) {
/// <b>show at later</b>
/// <span>@Model.Name</span>
/// etc
/// }
/// </code>
/// </example>
/// </para>
/// <para>
/// <example>
/// Print once (i.e. if within a looped partial), using identified block via <code>@Html.RenderDelayed("one-time")</code>. Code:
/// <code>
/// @using (Html.Delayed("one-time", isOnlyOne: "one-time")) {
/// <b>show me once</b>
/// <span>@Model.First().Value</span>
/// }
/// </code>
/// </example>
/// </para>
/// </summary>
/// <param name="helper">the helper from which we use the context</param>
/// <param name="injectionBlockId">optional unique identifier to specify one or many injection blocks</param>
/// <param name="isOnlyOne">extra identifier used to ensure that this item is only added once; if provided, content should only appear once in the page (i.e. only the first block called for this identifier is used)</param>
/// <returns>using block to wrap delayed output</returns>
public static IDisposable Delayed(this HtmlHelper helper, string injectionBlockId = null, string isOnlyOne = null) {
return new DelayedInjectionBlock(helper, injectionBlockId, isOnlyOne);
}
/// <summary>
/// Render all queued output blocks injected via <see cref="Delayed"/>.
/// <para>
/// <example>
/// Print all delayed blocks using default identifier (i.e. not provided)
/// <code>
/// @using (Html.Delayed()) {
/// <b>show me later</b>
/// <span>@Model.Name</span>
/// etc
/// }
/// </code>
/// -- then later --
/// <code>
/// @using (Html.Delayed()) {
/// <b>more for later</b>
/// etc
/// }
/// </code>
/// -- then later --
/// <code>
/// @Html.RenderDelayed() // will print both delayed blocks
/// </code>
/// </example>
/// </para>
/// <para>
/// <example>
/// Allow multiple repetitions of rendered blocks, using same <code>@Html.Delayed()...</code> as before. Code:
/// <code>
/// @Html.RenderDelayed(removeAfterRendering: false); /* will print */
/// @Html.RenderDelayed() /* will print again because not removed before */
/// </code>
/// </example>
/// </para>
/// </summary>
/// <param name="helper">the helper from which we use the context</param>
/// <param name="injectionBlockId">optional unique identifier to specify one or many injection blocks</param>
/// <param name="removeAfterRendering">only render this once</param>
/// <returns>rendered output content</returns>
public static MvcHtmlString RenderDelayed(this HtmlHelper helper, string injectionBlockId = null, bool removeAfterRendering = true) {
var stack = DelayedInjectionBlock.GetQueue(helper, injectionBlockId);
if( removeAfterRendering ) {
var sb = new StringBuilder(
#if DEBUG
string.Format("<!-- delayed-block: {0} -->", injectionBlockId)
#endif
);
// .count faster than .any
while (stack.Count > 0) {
sb.AppendLine(stack.Dequeue());
}
return MvcHtmlString.Create(sb.ToString());
}
return MvcHtmlString.Create(
#if DEBUG
string.Format("<!-- delayed-block: {0} -->", injectionBlockId) +
#endif
string.Join(Environment.NewLine, stack));
}
}
jsからpartialを実行することが正当に必要な場合は、jQueryが必要です。
<script type="text/javascript">
function scriptToExecute()
{
//The script you want to execute when page is ready.
}
function runWhenReady()
{
if (window.$)
scriptToExecute();
else
setTimeout(runWhenReady, 100);
}
runWhenReady();
</script>
邪魔にならない の原則に従い、 "_ myPartial"がスクリプトのセクションに直接コンテンツを挿入することはそれほど必要ではありません。これらの部分ビュースクリプトを別々の.jsファイルに追加して、それらを親ビューから@scriptsセクションに参照できます。
特にMVCを使用している場合、Webについて考える方法には根本的な欠陥があります。問題はJavaScriptがどういうわけかビューの責任だということです。ビューはビューであり、JavaScript（ビヘイビアまたはその他）はJavaScriptです。 SilverlightとWPFのMVVMパターンでは、 "view first"または "model first"に直面しています。 MVCでは、常にモデルの観点から推論を試みる必要があります。JavaScriptは多くの点でこのモデルの一部です。
AMD パターンの使用をお勧めします（私は RequireJS が好きです） ） JavaScriptを読み込むためにビューに頼る代わりに、JavaScriptをモジュールに分け、機能を定義し、JavaScriptからhtmlにフックします。これはあなたのコードをクリーンアップし、あなたの懸念を切り離し、そして人生を一挙に簡単にするでしょう。
あなたはこれらの拡張メソッドを使うことができます：（PartialWithScript.csとして保存）
namespace System.Web.Mvc.Html
{
public static class PartialWithScript
{
public static void RenderPartialWithScript(this HtmlHelper htmlHelper, string partialViewName)
{
if (htmlHelper.ViewBag.ScriptPartials == null)
{
htmlHelper.ViewBag.ScriptPartials = new List<string>();
}
if (!htmlHelper.ViewBag.ScriptPartials.Contains(partialViewName))
{
htmlHelper.ViewBag.ScriptPartials.Add(partialViewName);
}
htmlHelper.ViewBag.ScriptPartialHtml = true;
htmlHelper.RenderPartial(partialViewName);
}
public static void RenderPartialScripts(this HtmlHelper htmlHelper)
{
if (htmlHelper.ViewBag.ScriptPartials != null)
{
htmlHelper.ViewBag.ScriptPartialHtml = false;
foreach (string partial in htmlHelper.ViewBag.ScriptPartials)
{
htmlHelper.RenderPartial(partial);
}
}
}
}
}
次のように使用します。
パーシャルの例：（_MyPartial.cshtml）ifにhtmlを、elseにjsを入れてください。
@if (ViewBag.ScriptPartialHtml ?? true)
<p>I has htmls</p>
}
else {
<script type="text/javascript">
alert('I has javascripts');
</script>
}
あなたの_Layout.cshtml、またはパーシャルからスクリプトをレンダリングしたい場所に、次のものを（一度だけ）入れてください：それは現在のページのすべてのパーシャルのjavascriptだけをこの位置にレンダリングするでしょう。
@{ Html.RenderPartialScripts(); }
それからあなたのパーシャルを使用するために、単にこれをしてください：それはこの場所でHTMLだけをレンダリングするでしょう。
@{Html.RenderPartialWithScript("~/Views/MyController/_MyPartial.cshtml");}
私が考えることができる最初の解決策は、レンダリングされなければならない値を保存するためにViewBagを使うことです。
これが部分的な観点から行われるのであればまず第一に私は試したことがありません、しかしそれはimoであるべきです。
部分ビューでセクションを使用する必要はありません。
部分ビューに含めます。 jQueryが読み込まれた後に関数を実行します。コードの条件節を変更できます。
<script type="text/javascript">
var time = setInterval(function () {
if (window.jQuery != undefined) {
window.clearInterval(time);
//Begin
$(document).ready(function () {
//....
});
//End
};
}, 10); </script>
フリオスペーダー
部分ビューにセクションを挿入する方法はありますが、それはきれいではありません。親ビューから2つの変数にアクセスする必要があります。部分ビューの目的の1つはそのセクションを作成することなので、これらの変数を必要とするのは理にかなっています。
これは、部分ビューにセクションを挿入するときの外観です。
@model KeyValuePair<WebPageBase, HtmlHelper>
@{
Model.Key.DefineSection("SectionNameGoesHere", () =>
{
Model.Value.ViewContext.Writer.Write("Test");
});
}
そして部分的なビューを挿入するページに...
@Html.Partial(new KeyValuePair<WebPageBase, HtmlHelper>(this, Html))
この手法を使用して、セクションの内容を任意のクラスでプログラム的に定義することもできます。
楽しい！
これは私にとっては同じファイル内の部分的なビューのためにJavaScriptとHTMLを同じ場所に配置することを可能にしてくれました。同じ部分的なビューファイル内のhtmlと関連部分を見るための思考プロセスを助けます。
"_MyPartialView.cshtml"という部分ビューを使用するビューで
<div>
@Html.Partial("_MyPartialView",< model for partial view>,
new ViewDataDictionary { { "Region", "HTMLSection" } } })
</div>
@section scripts{
@Html.Partial("_MyPartialView",<model for partial view>,
new ViewDataDictionary { { "Region", "ScriptSection" } })
}
パーシャルビューファイル
@model SomeType
@{
var region = ViewData["Region"] as string;
}
@if (region == "HTMLSection")
{
}
@if (region == "ScriptSection")
{
<script type="text/javascript">
</script">
}
OPの目標は、彼がインラインスクリプトを自分の部分ビューに定義することです。これは、このスクリプトはその部分ビューにのみ固有であり、そのブロックを自分のスクリプトセクションに含めることを前提としています。
私は彼がそのパーシャルビューを自己完結型にすることを望んでいると思います。 Angularを使用した場合のアイデアはコンポーネントと似ています。
私のやり方は、スクリプトをそのままパーシャルビューの中にとどめることです。これに関する問題は、パーシャルビューを呼び出すときに、他のすべてのスクリプト（通常はレイアウトページの下部に追加される）の前にそこでスクリプトを実行する可能性があることです。その場合は、Partial Viewスクリプトに他のスクリプトを待たせるだけです。これを行うにはいくつかの方法があります。私が以前に使ったことがある最も簡単なものは、bodyでイベントを使うことです。
私のレイアウトでは、私はこのように下部に何かがあるでしょう：
// global scripts
<script src="js/jquery.min.js"></script>
// view scripts
@RenderSection("scripts", false)
// then finally trigger partial view scripts
<script>
(function(){
document.querySelector('body').dispatchEvent(new Event('scriptsLoaded'));
})();
</script>
それから私の部分的なビューで（一番下に）：
<script>
(function(){
document.querySelector('body').addEventListener('scriptsLoaded', function() {
// .. do your thing here
});
})();
</script>
もう1つの解決策は、スタックを使ってすべてのスクリプトをプッシュし、最後にそれぞれを呼び出すことです。他の解決策は、すでに述べたように、RequireJS/AMDパターンです。
Mvc Coreを使用すると、下記のようにきちんとしたTagHelper scriptsを作成できます。これは簡単にsectionタグに変換され、そこで名前も付けられます（または名前は派生型から取得されます）。依存性注入はIHttpContextAccessor用に設定する必要があることに注意してください。
スクリプトを追加するとき（例えば部分的に）
<scripts>
<script type="text/javascript">
//anything here
</script>
</scripts>
スクリプトを出力するとき（レイアウトファイルなど）
<scripts render="true"></scripts>
コード
public class ScriptsTagHelper : TagHelper
{
private static readonly object ITEMSKEY = new Object();
private IDictionary<object, object> _items => _httpContextAccessor?.HttpContext?.Items;
private IHttpContextAccessor _httpContextAccessor;
public ScriptsTagHelper(IHttpContextAccessor httpContextAccessor)
{
_httpContextAccessor = httpContextAccessor;
}
public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
{
var attribute = (TagHelperAttribute)null;
context.AllAttributes.TryGetAttribute("render",out attribute);
var render = false;
if(attribute != null)
{
render = Convert.ToBoolean(attribute.Value.ToString());
}
if (render)
{
if (_items.ContainsKey(ITEMSKEY))
{
var scripts = _items[ITEMSKEY] as List<HtmlString>;
var content = String.Concat(scripts);
output.Content.SetHtmlContent(content);
}
}
else
{
List<HtmlString> list = null;
if (!_items.ContainsKey(ITEMSKEY))
{
list = new List<HtmlString>();
_items[ITEMSKEY] = list;
}
list = _items[ITEMSKEY] as List<HtmlString>;
var content = await output.GetChildContentAsync();
list.Add(new HtmlString(content.GetContent()));
}
}
}
私はこれをまったく別の方法で解決しました（急いでいて、新しいHtmlHelperを実装したくないため）。
私は部分ビューを大きなif-elseステートメントでラップしました。
@if ((bool)ViewData["ShouldRenderScripts"] == true){
// Scripts
}else{
// Html
}
次に、カスタムViewDataを使用してPartialを2回呼び出しました。
@Html.Partial("MyPartialView", Model,
new ViewDataDictionary { { "ShouldRenderScripts", false } })
@section scripts{
@Html.Partial("MyPartialView", Model,
new ViewDataDictionary { { "ShouldRenderScripts", true } })
}
選択的に、あなたはあなたのFolder/index.cshtmlをマスターページとして使い、そしてセクションスクリプトを追加することができます。そして、あなたのレイアウトには、
@RenderSection("scripts", required: false)
そしてあなたのindex.cshtml：
@section scripts{
@Scripts.Render("~/Scripts/file.js")
}
そしてそれはあなたのすべての部分的なビューの上でうまくいくでしょう。それは私のために働く
私はこのコードを私の部分的な見方で追加し、問題を解決しました。それほどきれいではありませんが、うまくいきます。レンダリングしているオブジェクトのIDを確認する必要があります。
私は同様の問題を抱えていました、そこで私は以下の通りマスターページを持っていました：
@section Scripts {
<script>
$(document).ready(function () {
...
});
</script>
}
...
@Html.Partial("_Charts", Model)
しかし部分的な見方は、ScriptsセクションのJavaScriptに依存していました。部分的なビューをJSONとしてエンコードし、それをJavaScript変数にロードしてからdivを生成するためにこれを使用して、この問題を解決しました。
@{
var partial = Html.Raw(Json.Encode(new { html = Html.Partial("_Charts", Model).ToString() }));
}
@section Scripts {
<script>
$(document).ready(function () {
...
var partial = @partial;
$('#partial').html(partial.html);
});
</script>
}
<div id="partial"></div>
冥王星の考えはより良い方法で：
CustomWebViewPage.cs：
public abstract class CustomWebViewPage<TModel> : WebViewPage<TModel> {
public IHtmlString PartialWithScripts(string partialViewName, object model) {
return Html.Partial(partialViewName: partialViewName, model: model, viewData: new ViewDataDictionary { ["view"] = this, ["html"] = Html });
}
public void RenderScriptsInBasePage(HelperResult scripts) {
var parentView = ViewBag.view as WebPageBase;
var parentHtml = ViewBag.html as HtmlHelper;
parentView.DefineSection("scripts", () => {
parentHtml.ViewContext.Writer.Write(scripts.ToHtmlString());
});
}
}
Views\web.config：
<pages pageBaseType="Web.Helpers.CustomWebViewPage">
見る：
@PartialWithScripts("_BackendSearchForm")
部分的（_BackendSearchForm.cshtml）：
@{ RenderScriptsInBasePage(scripts()); }
@helper scripts() {
<script>
//code will be rendered in a "scripts" section of the Layout page
</script>
}
レイアウトページ：
@RenderSection("scripts", required: false)