TextBoxWaterMarkExtender を GridView などで使うと watermark が除去されない

最近、Microsoft ASP.NET AJAX Library に基づき作成されたコントロール集、ASP.NET AJAX Control Toolkit を使わせてもらう機会も増えてきた。
そんな今日この頃、ASP.NET AJAX Control Toolkit ver.1.0.10301 に収録されている TextBoxWaterMarkExtender コントロールについて問題にぶつかった。

TextBoxWaterMarkExtender コントロールは、TextBox コントロールを拡張し、拡張対象の TextBox コントロールの入力内容が空で且つフォーカスを持っていない場合は、予め設定しておいた "watermark"（透かし） テキストを TextBox 内に表示する、というものだ。
（公式サイトのライブデモはこちら：http://ajax.asp.net/ajaxtoolkit/TextBoxWatermark/TextBoxWatermark.aspx）

普通はやらないような実装だと思うのだが、TextBoxWaterMarkExtender コントロールを、反復系データリストコントロールである GridView の ItemTemplate 内で使用した。
すると、GridView 中2行目以降、TextBoxWaterMarkExtender によって拡張された TextBox コントロールについて、未入力のままであってもポストバック時に "watermark" テキストが入力内容として返ってくるのだ。

以下に問題を再現するサンプルを示す。
http://gentoo.dev-asp.net/samples/05UsingTextBoxWatermarkExtenderInDataList/

ブラウザに返された HTML コンテンツと、TextBoxWaterMarkExtender の C# ソースコードを見てみたところ、謎が解けた。

TextBoxWaterMarkExtender は、ClientScriptManager.RegisterOnSubmitStatement メソッドを使って、Submit 直前に "watermark" テキストをテキストボックスから取り除く JavaScript を注入する。RegisterOnSubmitStatement メソッドはスクリプトの重複登録を避けるために "キー" 文字列を添えてスクリプトコードを渡す仕様になっている。
ここで、TextBoxWaterMarkExtender は、自身の ID プロパティをキー文字列に使っていた。

今回の不具合はこれが原因である。

つまり、反復系データリストのテンプレート内のコントロールは、ID プロパティが同値のインスタンスが、バインドされたデータ件数ぶんだけ繰り返し現れるので、1行目のテンプレートに現れた TextBoxWaterMarkExtender のみが "watermark"除去用 Submit 時スクリプトの注入に成功し、2行目以降の TextBoxWaterMarkExtender は、ID プロパティ値を由来とするキー文字列が 1行目のものと重複するため、"watermark" 除去用 Submit 時スクリプトの注入は「すでに登録済み」としてフレームワークによって取り扱われないのである。

さて、対応方法はさほど難しくない。
TextBoxWaterMarkExtender の実装は、OnLoad メソッド内にて"watermark" 除去用 Submit 時スクリプトの注入を行っている。
そこで、まず、TextBoxWaterMarkExtender から派生した自前のクラスを作成し、OnLoad メソッドをオーバーライドする。
オーバーライドした OnLoad メソッドの実装内容はオリジナルの TextBoxWaterMarkExtender のコードをまるごとコピー&ペーストするが、一点だけ、RegisterOnSubmitStatement メソッドに渡すキー文字列を、（ID プロパティ由来はなく）UniqueID プロパティに由来するものとするよう、コードを変更すればよい。こうして作成した自前のクラスを使うようにすれば問題は解消される。

TextBoxWaterMarkExtender のソースを直接変更し、ASP.NET AJAX Control Toolkit の独自ビルドを使用するという手段も、場合によってはあるであろう。

今回の不具合は、今日時点の最新リリース、10301 で発生するが、CodePlex から最新のソースを取得してみても、特にこの点は変更はないようだ。
また、同 Issue Tracker をざっと眺めた感じでは、同類の不具合報告/改善要望は挙がっていないようだ。
後日、投稿してみることも検討中。

ところで、今回の件とは関係ないが、ASP.NET AJAX Control Toolkit について、CodePlex 上の Issue Tracker にはこれまたずいぶんとたくさんの不具合報告/改善要望が投稿されている。
内容をいくつか見てみたが、それだけ、ブラウザ互換やHTMLバージョン互換を維持するのは難しいのだな、という点や、今回の私のように、開発者が想定していたであろう場面を超えた利用が発生しているのだな、といった点がうかがい知れた。
とにかく、これだけ不具合報告/改善要望があがっていれば、今後もまだまだ成長しそうなプロダクトであるな、と感じた次第。