ASP.NET マスターページの概要

ASP.NET マスターページの概要

低帯域幅での表示をオンにする

すべて縮小

言語フィルタ

このページは次のバージョンについて記述しています。

Microsoft Visual Studio 2008/.NET Framework 3.5

その他のバージョンについては、以下の情報を参照してください。

ASP.NET

ASP.NET マスターページの概要

更新 : 2007 年 11 月

ASP.NET マスタページでは、アプリケーションのページに一貫性のあるレイアウトを作成できます。アプリケーション内のすべてのページ (またはページのグループ) に対する任意の外観と操作性、および標準動作が 1 つのマスタページで定義されます。その後で、表示するコンテンツを含む個々のコンテンツページを作成できます。ユーザーがコンテンツページを要求すると、マスターページとマージされて、マスタページのレイアウトとコンテンツページのコンテンツが結合された出力が生成されます。

マスタページのしくみ

マスタページは、実際にはマスタページそのものと、1 つ以上のコンテンツページで構成されています。

メモ :
また、マスタページは入れ子にできます。詳細については、「入れ子にされた ASP.NET マスタページ」を参照してください。

マスタページ

マスタページは拡張子が .master の ASP.NET ファイル (MySite.master など) で、静的テキスト、HTML 要素、およびサーバーコントロールを含む定義済みレイアウトを持ちます。マスタページは、普通の .aspx ページに使用される @ Page ディレクティブではなく特別な @ Master ディレクティブによって識別されます。ディレクティブは次のようになります。

Visual Basic

<%@ Master Language="VB" %>

<%@ Master Language="C#" %>

@ Master ディレクティブには @ Control ディレクティブに含めることができるディレクティブのほとんどを含めることができます。たとえば、次のマスタページディレクティブは、分離コードファイルの名前を含み、クラス名をマスタページに割り当てます。

Visual Basic

<%@ Master Language="VB" CodeFile="MasterPage.master.vb" Inherits="MasterPage" %>

<%@ Master Language="C#" CodeFile="MasterPage.master.cs" Inherits="MasterPage" %>

@ Master ディレクティブに加えて、マスタページは html、head、および form など、ページのすべての最上位 HTML 要素も含みます。たとえば、マスタページでは、レイアウトに HTML テーブル、会社ロゴに img 要素、著作権表記に静的テキスト、そしてサイトの標準ナビゲーションを作成するためのサーバーコントロールを使用できます。任意の HTML 要素と ASP.NET 要素をマスタページの一部として使用できます。

置き換え可能なコンテンツプレースホルダ

すべてのページに表示される静的テキストとコントロールの他に、マスタページには 1 つ以上の ContentPlaceHolder コントロールも含まれます。これらのプレースホルダコントロールは、置き換え可能なコンテンツが表示される領域を定義します。次に、置き換え可能なコンテンツはコンテンツページで定義されます。ContentPlaceHolder コントロールを定義すると、マスタページは次のようになります。

Visual Basic

<% @ Master Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 
    1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html  >
<head runat="server" >
    <title>Master page title</title>
</head>
<body>
    <form id="form1" runat="server">
        <table>
            <tr>
                <td><asp:contentplaceholder id="Main" runat="server" /></td>
                <td><asp:contentplaceholder id="Footer" runat="server" /></td>
            </tr>
        </table>
    </form>
</body>
</html>

<%@ Master Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 
    1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html  >
<head runat="server" >
    <title>Master page title</title>
</head>
<body>
    <form id="form1" runat="server">
        <table>
           <tr>
               <td><asp:contentplaceholder id="Main" runat="server" /></td>
               <td><asp:contentplaceholder id="Footer" runat="server" /></td>
           </tr>
        </table>
    </form>
</body>
</html>

コンテンツページ

マスタページのプレースホルダコントロールのコンテンツを個々のコンテンツページを作成することによって定義します。個々のコンテンツページとは特定のマスタページにバインドされている ASP.NET ページ (.aspx ファイル、およびオプションで分離コードファイル) です。バインディングは、使用されるマスタページを指定する MasterPageFile 属性を含めることによって、コンテンツページの @ Page ディレクティブで確立されます。たとえば、コンテンツページには次のような @ Page ディレクティブを含めることができます。このディレクティブはコンテンツページを Master1.master ページにバインドします。

Visual Basic

<%@ Page Language="VB" MasterPageFile="~/MasterPages/Master1.master" Title="Content Page" %>

<%@ Page Language="C#" MasterPageFile="~/MasterPages/Master1.master" Title="Content Page"%>

コンテンツページでは、Content コントロールを追加し、これらをマスタページの ContentPlaceHolder コントロールに割り当てることによってコンテンツを作成します。たとえば、マスタページに Main とFooter というコンテンツプレースホルダが含まれるとします。このコンテンツページには 2 つの Content コントロールを作成できます。次の図に示すように、1 つは ContentPlaceHolder の Main コントロールに割り当てられ、もう 1 つは ContentPlaceHolder の Footer コントロールに割り当てられます。

プレースホルダコンテンツの置き換え

Content コントロールを作成した後で、これらのコントロールにテキストとコントロールを追加します。コンテンツページでは、Content コントロール内にないもの (サーバーコードのスクリプトブロックを除く) はエラーとなります。コンテンツページでは、ASP.NET ページで実行できるタスクはすべて実行できます。たとえば、サーバーコントロールとデータベースクエリ、またはその他の動的な機構を使用して Content コントロールのコンテンツを生成できます。

コンテンツページは、たとえば次のようになります。

Visual Basic

<% @ Page Language="VB" MasterPageFile="~/Master.master" Title="Content Page 1" %>
<asp:Content ID="Content1" ContentPlaceHolderID="Main" Runat="Server">
    Main content.
</asp:Content>
    
<asp:Content ID="Content2" ContentPlaceHolderID="Footer" Runat="Server" >
    Footer content.
</asp:content>

[C#]

<% @ Page Language="C#" MasterPageFile="~/Master.master" Title="Content Page 1" %>
<asp:Content ID="Content1" ContentPlaceHolderID="Main" Runat="Server">
    Main content.
</asp:Content>
    
<asp:Content ID="Content2" ContentPlaceHolderID="Footer" Runat="Server" >
    Footer content.
</asp:content>

@ Page ディレクティブは、コンテンツページを特定のマスタページにバインドし、マスタページにマージされるページのタイトルを定義します。コンテンツページには、Content コントロールの外側にあるその他のマークアップは含まれません (マスタページには、実行時にタイトル設定をマージできるように runat="server" 属性付きの head 要素が含まれる必要があります)。

複数のマスタページを作成すると、サイトの部分ごとに異なるレイアウト、およびマスタページごとに異なるコンテンツページセットを定義できます。

マスタページの利点

マスタページには、これまで開発者が既存のコード、テキスト、およびコントロール要素を繰り返しコピーし、フレームセット、共通要素のインクルードファイル、ASP.NET ユーザーコントロールなどを使用して作成してきた機能が用意されています。マスタページには次のような利点があります。

ページの共通機能を集中化できるため、1 か所だけで更新を行うことができます。
一連のコントロールとコードを作成し、その結果を簡単にページセットに適用できます。たとえば、マスタページのコントロールを使用してメニューを作成し、すべてのページに適用できます。
プレースホルダコントロールの表示方法を制御できるため、最終ページのレイアウトをきめ細かく制御できます。
個々のコンテンツページからマスタページをカスタマイズできるオブジェクトモデルが用意されています。

マスタページの実行時の動作

実行時には、マスタページは次のシーケンスで処理されます。

ユーザーはコンテンツページの URL を入力することでページを要求します。
ページがフェッチされると、@ Page ディレクティブが読み取られます。ディレクティブがマスタページを参照する場合、マスタページも同様に読み取られます。これがページの初めての要求であった場合は、両方のページがコンパイルされます。
コンテンツが更新されているマスタページは、コンテンツページのコントロールツリーにマージされます。
個々のContent コントロールのコンテンツは、マスタページ内の対応する ContentPlaceHolder コントロールにマージされます。
結果としてマージされたページが、ブラウザに表示されます。

このプロセスは次のようになります。

実行時のマスタページ

ユーザーの観点からは、連結されたマスタページとコンテンツページは単一の独立したページです。ページの URL はコンテンツページの URL です。

プログラミングの観点からは、2 つのページはそれぞれのコントロールの別個のコンテナとして動作します。コンテンツページはマスタページのコンテナとして動作します。ただし、次のセクションで説明するように、コンテンツページのコードからパブリックマスタページメンバを参照できます。

マスタページはコンテンツページの一部となります。実際には、マスタページは、コンテンツページの子として、またそのページ内のコンテナとして動作します。これは、ユーザーコントロールの動作とほぼ同じです。ただし、この場合、マスタページは、ブラウザに表示されるすべてのサーバーコントロールのコンテナです。マージされたマスタページとコンテンツページのコントロールツリーは、たとえば次のようになります。

Page
    Master Page
        (Master page markup and controls)
        ContentPlaceHolder
            Content page markup and server controls
        (Master page markup and controls)
        ContentPlaceHolder
            Content page markup and server controls
        (Master page markup and controls)

このダイアグラムは簡略化されています。コンテンツページが対応する Content コントロールを持たない場合、マスタページは、ContentPlaceHolder コントロール内にマークアップとコントロールを持つことになります。

一般に、この構造はページの構築方法やページのプログラム方法には影響しません。ただし、場合によっては、マスタページにページ全体のプロパティを設定すると、マスタページはページ上のコントロールにとって最も近い親であるため、構造がコンテンツページの動作に影響することがあります。たとえば、コンテンツページの EnableViewState プロパティを true に設定し、マスタページで同じプロパティを false に設定している場合、マスタページ上の設定が優先されるため、実際にはビューステートが無効化されます。

マスタページとコンテンツページのパス

コンテンツページが要求されると、そのコンテンツがマスタページにマージされ、ページはコンテンツページのコンテキスト内で実行されます。たとえば、HttpRequest オブジェクトの CurrentExecutionFilePath プロパティを取得する場合、プロパティがコンテンツページコード内にあるかマスタページコード内にあるかに関係なく、パスはコンテンツページの場所を表します。

マスタページとコンテンツページを同じフォルダに入れる必要はありません。コンテンツページの @ Page ディレクティブの MasterPageFile 属性が .master ページに解決する限り、ASP.NET ではコンテンツページとマスタページが 1 つの表示ページにマージされます。

外部リソースの参照

コンテンツページとマスタページの両方に外部リソースを参照するコントロールと要素を含めることができます。たとえば、両方がイメージファイルを参照するイメージコントロールを含んだり、他のページを参照するアンカーを含んだりできます。

マージされたコンテンツページとマスタページのコンテキストは、コンテンツページのコンテキストです。これは、アンカー内のリソース、つまりイメージファイルやターゲットページなどの URL を指定する方法に影響することがあります。

サーバーコントロール

マスタページのサーバーコントロールでは、外部リソースを参照するプロパティの URL を ASP.NET が動的に変更します。たとえば、マスタページに Image コントロールを配置し、その ImageUrl プロパティをマスタページを基準とするように設定するとします。実行時に、ASP.NET はコンテンツページのコンテキスト内で正しく解決するように URL を変更します。

ASP.NET は URL を次のような場合に変更できます。

URL が ASP.NET サーバーコントロールのプロパティである場合。
プロパティがコントロール内で URL として内部的にマークされている場合 (プロパティは UrlPropertyAttribute 属性でマークされている)。実際には、一般的に外部リソースの参照に使用される ASP.NET サーバーコントロールのプロパティがこのようにマークされます。

他の要素

ASP.NET はサーバーコントロールではない要素の URL は変更できません。たとえば、マスタページで img 要素を使用していて、その src 属性を URL に設定している場合、ASP.NET は URL を変更しません。その場合、URL はコンテンツページのコンテキスト内で解決され、URL を適切に作成します。

一般に、マスタページの要素を操作する場合、サーバーコードを必要としない要素についても、サーバーコントロールを使用することをお勧めします。たとえば、img 要素を使用する代わりに、Image サーバーコントロールを使用してください。その方が ASP.NET は URL を正しく解決できるため、マスタページやコンテンツページを移動すると生じる可能性のある保守の問題を回避できます。

ASP.NET サーバーコントロールのパス指定の詳細については、「ASP.NET Web サイトのパス」を参照してください。

マスタページとテーマ

ASP.NET テーマをマスタページに直接適用することはできません。テーマ属性を @ Master ディレクティブに追加すると、その実行時にページにエラーが発生します。

ただし、次の状況では、テーマはマスタページに適用されます。

テーマがコンテンツページで定義されている場合。マスタページはコンテンツページのコンテキストで解決されるため、コンテンツページのテーマはマスタページにも同様に適用されます。
テーマ定義を pages 要素 (ASP.NET 設定スキーマ) 要素に含めることによって、サイト全体がテーマを使用するように設定されている場合。

詳細については、「ASP.NET のテーマとスキンの概要」を参照してください。

マスタページのスコープの設定

コンテンツページは次の 3 つのレベルでマスタページに結合できます。

ページレベル次のコード例のように、各コンテンツページのページディレクティブを使用してコンテンツページをマスタページにバインドできます。
Visual Basic
```
<%@ Page Language="VB" MasterPageFile="MySite.Master" %> 
```
C#
```
<%@ Page Language="C#" MasterPageFile="MySite.Master" %> 
```
アプリケーションレベルアプリケーションの構成ファイル (Web.config) の pages 要素で設定を行うことによって、アプリケーション内のすべての ASP.NET ページ (.aspx ファイル) が自動的にマスタページにバインドされるように指定できます。この要素は次のようになります。
```
<pages masterPageFile="MySite.Master" />
```
この方法では、アプリケーション内の Content コントロールを持つすべての ASP.NET ページが指定されたマスタページでマージされます (ASP.NET ページが Content コントロールを含まない場合、マスタページは適用されません)。
フォルダレベルこの方法は、1 つのフォルダだけで Web.config ファイルの設定を行うという点を除いては、アプリケーションレベルでのバインディングに似ています。マスタページのバインディングは、そのフォルダ内の ASP.NET ページに適用されます。