マスターページ利用環境でのFindControlによるコンテンツフォームのコントロール取得方法 - ASP.NET

マスターページを利用している場合、コンテンツフォームのコントロールをFindContrlでは取得できない場合があります。

概要

マスターページを利用している場合は、
  TextBox lc = (TextBox)Page.FindControl(ControlName);
  TextBox lc = (TextBox)(Master.FindControl("ContentPlaceHolder1").FindControl(ControlName));
のように変更します。

現象の確認

マスターページ

マスターページを作成します。
マスターページのaspxファイルは下記になります。
Site.master
<%@ Master Language="C#" AutoEventWireup="true" CodeBehind="Site.master.cs" Inherits="FindControlDemo.Site" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title></title>
    <asp:ContentPlaceHolder ID="head" runat="server">
    </asp:ContentPlaceHolder>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:ContentPlaceHolder ID="ContentPlaceHolder1" runat="server">
  
        </asp:ContentPlaceHolder>
    </div>
    </form>
</body>
</html>

UI(Webフォーム)

下図のUIを作成します。テキストボックス、ボタンを配置します。


aspxファイルは下記になります。
Default.aspx
<%@ Page Title="" Language="C#" MasterPageFile="~/Site.Master" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="FindControlDemo.Default" %>
<asp:Content ID="Content1" ContentPlaceHolderID="head" runat="server">
</asp:Content>
<asp:Content ID="Content2" ContentPlaceHolderID="ContentPlaceHolder1" runat="server">
  <div>
    <asp:TextBox ID="TextBox1" runat="server"></asp:TextBox><br />
    <asp:Button ID="Button1" runat="server" Text="Button" OnClick="Button1_Click" />
 </div>
</asp:Content>

コード

以下のコードを記述します。
Default.aspx.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace FindControlDemo
{
  public partial class Default : System.Web.UI.Page
  {
    protected void Page_Load(object sender, EventArgs e)
    {

    }

    protected void Button1_Click(object sender, EventArgs e)
    {
      TextBox tb = (TextBox)Page.FindControl("textBox1");
      tb.Text = "ぺんぎん";
    }
  }
}

実行結果

プロジェクトを実行します。下図のウィンドウが表示されます。


[Button]をクリックすると例外が発生します。FindControlで取得した結果がnullになっているため、例外が発生します。

対策方法

ロジック部分のコードを以下のコードにします。
Default.aspx.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace FindControlDemo
{
  public partial class Default : System.Web.UI.Page
  {
    protected void Page_Load(object sender, EventArgs e)
    {

    }

    protected void Button1_Click(object sender, EventArgs e)
    {
      TextBox tb = (TextBox)(Master.FindControl("ContentPlaceHolder1").FindControl("textBox1"));
      tb.Text = "ぺんぎん";
    }
  }
}

実行結果

プロジェクトを実行します。下図のウィンドウが表示されます。


[Button]をクリックします。テキストボックスに文字列が設定できました。FindControlでコントロールが取得できていることがわかります。

まとめ

マスターページを利用している場合は、単純なFindControl呼び出しではなく、マスターページからContentPlaceHolderを取得し、ContentPlaceHolderに対してFindControlを呼び出す必要があります。
著者
iPentecのメインプログラマー
C#, ASP.NET の開発がメイン、少し前まではDelphiを愛用
最終更新日: 2024-01-06
作成日: 2009-11-15
iPentec all rights reserverd.