MasterPage クラス (System.Web.UI)

すべて縮小

言語フィルタ

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

Microsoft Visual Studio 2008/.NET Framework 3.5

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

.NET Framework クラスライブラリ

MasterPage クラス

更新 : 2007 年 11 月

Content コントロールおよびそれぞれのコントロールのみで構成されるページのテンプレートおよびマージコンテナとして機能します。

名前空間 : System.Web.UI
アセンブリ : System.Web (System.Web.dll 内)

構文

Visual Basic (宣言)

<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class MasterPage _
    Inherits UserControl

Visual Basic (使用法)

Dim instance As MasterPage

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class MasterPage : UserControl

Visual C++

[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class MasterPage : public UserControl

/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public class MasterPage extends UserControl

JScript

public class MasterPage extends UserControl

ASP.NET

<asp:MasterPage />

解説

マスタページは、ASP.NET Web アプリケーションのコンテンツページのテンプレートコンテナおよびマージページとして機能します。マスタページを使用すると、一連のコンテンツページ全体で構造および内容を簡単に共有できます。コンテンツプレースホルダを使用して、コンテンツページの内容で置き換えるマスタページのセクションを定義します。

マスタページおよび関連するコンテンツページを使用する場合、必要な XHTML 文書タグ (html、head、body など) はマスタページのみに追加し、他の .aspx ファイル (ASP.NET ページ) をスタンドアロンの Web ページとして作成しません。コンテンツページには、マスタページのプレースホルダに挿入する内容を定義します。

実行時に HTTP 要求が行われると、マスタページとコンテンツページが結合され、コンテンツページと同じ名前の単一のクラスが生成されます。結果として得られたコンパイル済みのマージされたクラスは、Page クラスから派生します。

マスタページには、直接的なマークアップやサーバーコントロール、およびコンテナコントロールを定義できます。マスタページ内で ContentPlaceHolder コントロールの外側にある各要素は、マスタページとコンテンツページをマージした結果生成されるすべてのページに表示されます。

マスタページに関連する各コンテンツページは、@ Page ディレクティブの MasterPageFile 属性でマスタページを参照する必要があります。コンテンツページには、@ Page ディレクティブと 1 つ以上の Content コントロールのみを定義できます。ページテキスト、マークアップ、およびサーバーコントロールはすべて、Content コントロール内に配置する必要があります。Content コントロールが関連付けられているマスタページの ContentPlaceHolder コントロールを識別するには、Content コントロールの ContentPlaceHolderID プロパティを設定します。

実行時に、要求されたページの各 Content コントロールの動的な内容がマスタページにマージされ、関連する ContentPlaceHolder コントロールの正確な場所に配置されます。マスタページ内のその他のマークアップおよびコントロールは影響を受けません。イベントハンドラは、マスタクラスにもコンテンツページにも定義できます。詳細については、「ASP.NET のマスターページとコンテンツページのイベント」を参照してください。

MasterPage クラスは、.master 拡張子を持つファイルと関連付けられています。これらのファイルは、実行時に MasterPage オブジェクトとしてコンパイルされ、サーバーメモリにキャッシュされます。

コンテンツページでマスタページを利用できるようにするには、Page 基本クラスの Master プロパティを使用します。Master プロパティはマスタページのインスタンスを返しますが、このインスタンスは MasterPage 基本クラスとして型指定されています。マスタページのコントロール、プロパティ、および関数にアクセスするために、Master プロパティを MasterPage にキャストできます。マスタページのクラス名は、@ Master ディレクティブの ClassName 属性を使用して定義します。

メモ :
拡張子が .master のファイルはブラウザには提供されません。

マスタページで有効なディレクティブは UserControl オブジェクトで使用できるディレクティブと同じです。次の属性を設定できます。

AutoEventWireup
ClassName
CodeFile
CompilerMode
CompilerOptions
Debug
Description
EnableTheming
EnableViewState
Explicit
Inherits
Language
LinePragmas
MasterPageFile
Src
Strict
WarningLevel

マスタページのディレクティブは、個別のコンテンツページのディレクティブをオーバーライドしません。

通常、マスタページは宣言によって作成されます。マスタページをプログラムによって作成する場合は、MasterPage クラスから直接派生させます。MasterPage クラスを拡張することに加えて、.master ファイルを作成して、ソースファイルで呼び出したクラスに関連付けられているユーザーインターフェイス (UI) を視覚的に表示できるようにする必要があります。

メモ :
最初に独自のクラスを作成することによりマスタページを作成する場合は、そのページで使用されるクラスに必要なすべての名前空間を指定する必要があります。

マスタページの詳細については、「ASP.NET マスターページの概要」を参照してください。

Topic	Location
方法 : ASP.NET マスタページのコンテンツページを作成します。	dv_vwdcon
方法 : ASP.NET マスタページ用のコンテンツページを作成する	Visual Studio ASP .NET での Web アプリケーションの作成
方法 : ASP.NET マスタページ用のコンテンツページを作成する (Visual Studio)	Visual Studio での ASP .NET Web アプリケーションの作成
方法 : ASP.NET マスターページのコンテンツを参照する	ASP .NET Web アプリケーションの作成
方法 : ASP.NET マスターページのコンテンツを参照する	Visual Studio ASP .NET での Web アプリケーションの作成
方法 : 参照 ASP.NET マスタページコンテンツ	dv_vwdcon

例

このセクションには、4 つのコード例が含まれています。

最初のコード例では、宣言によってマスタページを作成する方法を示します。
2 番目のコード例では、最初のコード例で作成されたマスタページに関連付けられたコンテンツページを示します。
3 番目のコード例では、マスタページにプロパティを追加する方法を示します。
4 番目のコード例では、コンテンツページを使用してマスタページのパブリックプロパティにアクセスする方法を示します。

宣言によってマスタページを作成し、コンテンツページを使用してマスタページに内容を追加する方法を次の例に示します。最初の Web ページは、MasterPageSample_1.master という名前の .master ページです。

<%@ 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>MasterPage Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server" />
    </div>
    </form>
</body>
</html>

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>MasterPage Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server" />
    </div>
    </form>
</body>
</html>

MasterPageSample_1.master に関連付けられているコンテンツページを表す例を次に示します。この例には、Content コントロールが含まれており、ContentPlaceHolderID プロパティを使用して、コンテンツが関連付けられている ContentPlaceHolder コントロールを指定しています。

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

<asp:content 
    runat="server"
    contentplaceholderid="ContentPlaceHolder1" >Hello, Master Pages!</asp:content>

Visual Basic

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

<asp:content 
    runat="server"
    contentplaceholderid="ContentPlaceHolder1" >Hello, Master Pages!</asp:content>

次の例では、マスタページにプロパティを追加する方法を示します。ClassName 属性を使用して、マスタページの名前を指定しています。

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

<script runat="server">
        public string SiteName
        {
            get { return "My Site Name"; }
        }
</script>

<html  >
<head runat="server">
    <title>MasterPage Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server">
        </asp:contentplaceholder>
    </div>
    </form>
</body>
</html>

Visual Basic

<%@ Master Language="VB" ClassName="MasterExample" %>

<script runat="server">
  Public ReadOnly Property SiteName() As String
    Get
      Return "My Site Name"
    End Get
  End Property

</script>

<html  >
<head runat="server">
    <title>MasterPage Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:contentplaceholder id="ContentPlaceHolder1" runat="server">
        </asp:contentplaceholder>
    </div>
    </form>
</body>
</html>

コンテンツページを使用して、前のコード例のマスタページの SiteName パブリックプロパティにアクセスする方法を次の例に示します。

<%@ Page Language="C#" MasterPageFile="~/MasterPage.master" Title="MasterPage Example" %>

<script runat="server">
  protected void Page_Load(object sender, EventArgs e)
  {
    MasterExample m = (MasterExample)Page.Master;
    mylabel.Text = m.SiteName;
  }
</script>

<asp:Content ID="Content1" ContentPlaceHolderID="ContentPlaceHolder1" runat="Server">
    Hello, Master Pages!
    <asp:Label runat="server" Text="Label" ID="mylabel"></asp:Label>
</asp:Content>

Visual Basic

<%@ Page Language="VB" MasterPageFile="~/MasterPage.master" Title="MasterPage Example" %>

<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
    Dim m As MasterExample = CType(Page.Master, MasterPage)
    mylabel.Text = m.SiteName
  End Sub
</script>

<asp:Content ID="Content1" ContentPlaceHolderID="ContentPlaceHolder1" runat="Server">
    Hello, Master Pages!
    <asp:Label runat="server" Text="Label" ID="mylabel"></asp:Label>
</asp:Content>

アクセス許可

AspNetHostingPermission
(ホスト環境での動作に必要なアクセス許可)。要求値 : LinkDemand。アクセス許可値 : Minimal。
AspNetHostingPermission
(ホスト環境での動作に必要なアクセス許可)。要求値 : InheritanceDemand。アクセス許可値 : Minimal。

継承階層

System..::.Object
  System.Web.UI..::.Control
    System.Web.UI..::.TemplateControl
      System.Web.UI..::.UserControl
        System.Web.UI..::.MasterPage

スレッドセーフ

この型のすべてのパブリック static (Visual Basic では Shared) メンバは、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

.NET Framework および .NET Compact Framework では、各プラットフォームのすべてのバージョンはサポートしていません。サポートされているバージョンについては、「.NET Framework システム要件」を参照してください。

バージョン情報