如何在Substitution控件中使用ASP.Net服务器控件？

Question

在替换控件中使用的方法应该返回字符串，那么如何在服务器端呈现的服务器控件（例如Loginview控件）上使用甜甜圈缓存呢？

- mhmd

Answer 1

更新 这是一个完全可用的示例，这里有几个要点：

1. 使用替换控件的回调来呈现所需的用户控件的输出。
2. 使用自定义页面类覆盖VerifyRenderingInServerForm和EnableEventValidation以加载控件，以防止包含需要表单标记或事件验证的服务器控件时抛出错误。

以下是标记：

<asp:Substitution runat="server" methodname="GetCustomersByCountry" />

这是回调函数

public string GetCustomersByCountry(string country)
{
   CustomerCollection customers = DataContext.GetCustomersByCountry(country);

    if (customers.Count > 0)
        //RenderView returns the rendered HTML in the context of the callback
        return ViewManager.RenderView("customers.ascx", customers);
    else
        return ViewManager.RenderView("nocustomersfound.ascx");
}

这是用于渲染用户控件的辅助类

public class ViewManager
{
    private class PageForRenderingUserControl : Page
    {
        public override void VerifyRenderingInServerForm(Control control)
        { /* Do nothing */ }

        public override bool EnableEventValidation
        {
            get { return false; }
            set { /* Do nothing */}
        }
    }

    public static string RenderView(string path, object data)
    {
        PageForRenderingUserControl pageHolder = new PageForUserControlRendering();
        UserControl viewControl = (UserControl) pageHolder.LoadControl(path);

        if (data != null)
        {
            Type viewControlType = viewControl.GetType();
            FieldInfo field = viewControlType.GetField("Data");
            if (field != null)
            {
                field.SetValue(viewControl, data);
            }
            else
            {
                throw new Exception("ViewFile: " + path + "has no data property");
            }
        }

        pageHolder.Controls.Add(viewControl);
        StringWriter result = new StringWriter();
        HttpContext.Current.Server.Execute(pageHolder, result, false);
        return result.ToString();
    }
}

请查看以下相关问题：

• 如何在用户控件中关闭页面级缓存
• 使用C#.NET时，UserControl的 RenderControl 要求添加一个表单标签

- Micah

---

-1 参考源：http://weblogs.asp.net/scottgu/archive/2006/10/22/Tip_2F00_Trick_3A00_-Cool-UI-Templating-Technique-to-use-with-ASP.NET-AJAX-for-non_2D00_UpdatePanel-scenarios.aspx请只返回翻译后的文本。 - user338195

Answer 2

Micah的回答中遗漏了一件事情，那就是替换函数必须是static，接受一个HttpContext参数，并返回一个string。请参阅this msdn page以获取更多信息。

我还扩展了Micah的辅助类，使其更加灵活。

标记

<asp:Substitution ID="Substitution1" MethodName="myFunction" runat="server" />

实现

public static string myFunction(HttpContext httpContext){
   ViewManager vm = new ViewManager();

   //example using a Button control

   Button b = new Button();
   b.Text = "click me"; //we can set properties like this

   //we can also set properties with a Dictionary Collection
   Dictionary<string,object> data =  new Dictionary<string,object>();
   data.add("Visible",true); 

   String s = vm.RenderView(b,data); //don't do anything (just for example)

   //we can also use this class for UserControls
   UserControl myControl = vm.GetUserControl("~mypath");

   data.clear();
   data.add("myProp","some value");

   return vm.RenderView(myControl,data); //return for Substitution control
}

类

using System.IO;
using System.ComponentModel;
public class ViewManager
{
    private PageForRenderingUserControl pageHolder;
    public ViewManager()
    {
        pageHolder = new PageForRenderingUserControl();
    }

    public UserControl GetUserControl(string path)
    {
        return (UserControl)pageHolder.LoadControl(path);
    }

    public string RenderView(Control viewControl, Dictionary<string, object> data)
    {
        pageHolder.Controls.Clear();
        //Dim viewControl As UserControl = DirectCast(pageHolder.LoadControl(Path), UserControl)

        if (data != null) {
            Type viewControlType = viewControl.GetType();


            dynamic properties = TypeDescriptor.GetProperties(viewControl);

            foreach (string x in data.Keys) {
                if ((properties.Item(x) != null)) {
                    properties.Item(x).SetValue(viewControl, data[x]);
                }
            }
        }

        pageHolder.Controls.Add(viewControl);
        StringWriter result = new StringWriter();
        HttpContext.Current.Server.Execute(pageHolder, result, false);
        return result.ToString();
    }

    private class PageForRenderingUserControl : Page
    {
        public override void VerifyRenderingInServerForm(Control control)
        {
            // Do nothing 
        }

        public override bool EnableEventValidation {
            get { return false; }
            // Do nothing 
            set { }
        }
    }

}

再次感谢Micah提供的代码

- NSjonas

Answer 3

我相当确定你不能这样做 - 替换控件只允许您将字符串插入到输出缓存页面中。
如果您考虑服务器控件的整个输出，这就是有意义的，因为它可能是一个<table>，会破坏您精心制作的标记和/或需要大量<script>注入到页面中 - 而插入单个字符串则相对简单。

- PhilPursglove