如何为用户控件添加可扩展属性？

Question

我正在为现有的ASP.NET用户控件构建一些自定义JavaScript功能。该用户控件需要了解其嵌套控件的属性。因此，我选择使用expando属性而不是全局JavaScript变量，如下所示：

Page.ClientScript.RegisterExpandoAttribute(Me.ClientID, "validatorsenabled", Me.ValidatorsEnabled)

然而，尽管 expando 正确地输出到客户端，但用户控件本身在 HTML 中没有相应的元素。因此，由 ASP.NET 自动生成的以下 JavaScript 会出现“对象为空”的错误：

var ctl00_MainContentHolder_Payment_CreditCardInput1 = document.all ? document.all["ctl00_MainContentHolder_Payment_CreditCardInput1"] : document.getElementById("ctl00_MainContentHolder_Payment_CreditCardInput1");
ctl00_MainContentHolder_Payment_CreditCardInput1.validatorsenabled = "False";

我进行了一些调查并发现 这个页面 指出实现 IWebPart 接口可能行得通，但我尝试过没有成功。

有没有办法让 UserControl 输出类似服务器控件的标记？或者唯一的选项是将整个东西转换为服务器控件（在这种情况下与网站设计背道而驰）？

如果有其他想法来声明用户控件中的共享 JavaScript 属性，我愿意听取建议。

- NightOwl888

---

我不确定我是否理解正确，但您认为在您的情况下隐藏字段有用吗？ - gbs

有趣的想法。可以在我的用户控件中包含一个隐藏字段，但是仍然存在一个问题，即包含它的控件将如何知道隐藏字段的名称。请记住，在页面上可能会有多个用户控件实例。 - NightOwl888

Answer 1

我在原来的解决方案之后找到了一个更好的解决方案

我找到了一种解决方法。

似乎（由于缺乏响应和搜索该术语时缺乏结果），绝大多数人都不知道expando属性及其有用性。您知道当您向ASP.NET页面添加验证控件并且您在页面底部获得那个相当大的JavaScript块时，该块会设置一些属性（例如启用和errormessage）吗？我所指的就是它们。它们可以使用Page.ClientScript.RegisterExpandoAttribute()方法输出到页面 - 实质上，它们是使您的标记有效的HTML，同时允许您添加其他（有意义的）属性以供javascript使用。它们通过HTML DOM添加并可被访问，但实际上它们并不存在于HTML中。

无论如何，回到我的解决方案。我只是在用户控件中添加了2个文字控件 - 一个在最开始，一个在最后，并在代码后台中添加了具有用户控件ID的控件元素的标记（因为用户控件不会输出一个）。因此，标记看起来像这样：

<%@ Control Language="VB" AutoEventWireup="false" CodeFile="CreditCardInput.ascx.vb" Inherits="BVModules_Controls_CreditCardInput" %>
<asp:Literal ID="litControlBegin" runat="server" />

<!-- User Control Content Here -->

<asp:Literal ID="litControlEnd" runat="server" />

然后在代码后端，我做了这个：

Me.litControlBegin.Text = String.Format("<div id=""{0}"" class=""creditcardinput"">", Me.ClientID)
Me.litControlEnd.Text = "</div>"

现在，HTML中将存在一个与UserControl的ID（ClientID）对应的元素。这基本上为我提供了一个唯一的命名空间来添加扩展属性，并且让其他控件可以轻松地识别这些属性并将其与我的用户控件关联起来。然后使用以下代码添加扩展属性：

Page.ClientScript.RegisterExpandoAttribute(Me.ClientID, "validatorsenabled", Me.ValidatorsEnabled)

由于我手动添加的HTML元素，它不再崩溃。如果用户控件能够像服务器控件一样处理这个细节，那就太好了，但这个解决方法是一个合适的替代品。

更好的解决方案

通常情况下，当你不得不使用字符串解析时，你应该仔细看看是否有更好的方法。这次恰好有一个——重写Render方法（就像服务器控件一样），并使用HtmlTextWriter上的内置方法来生成输出。

Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter)
    writer.AddAttribute(HtmlTextWriterAttribute.Id, Me.ClientID)
    writer.RenderBeginTag(HtmlTextWriterTag.Div)
    MyBase.Render(writer)
    writer.RenderEndTag()
End Sub

这与我其他解决方案中的代码在功能上是等效的 - 它会生成一个带有我的用户控件ID的DIV标签。但是，它不需要像原始代码一样在Page_Load中添加额外的代码，更好地利用了框架，并且不需要任何字符串格式化或连接。

现在，这行代码将直接向用户控件添加一个扩展属性（在javascript中）：

Page.ClientScript.RegisterExpandoAttribute(Me.ClientID, "validatorsenabled", Me.ValidatorsEnabled)

- NightOwl888