プログラムでマスターページを指定する (C#)

[アーティクル]
07/13/2023

PreInit イベントハンドラーを使用してプログラムでコンテンツページのマスターページを設定する方法について説明します。

はじめに

「 マスターページを使用した Site-Wide レイアウトの作成」の第 1 の例以降、すべてのコンテンツページはディレクティブの属性を MasterPageFile 使用して宣言的にマスターページを @Page 参照しています。たとえば、次 @Page のディレクティブは、コンテンツページをマスターページ Site.masterにリンクします。

<%@ Page Language="C#" MasterPageFile="~/Site.master" ... %>

Page名前空間の System.Web.UI クラスには、コンテンツページのマスターページへのパスを返すプロパティが含まれていますMasterPageFile。これは、ディレクティブによって@Page設定されるこのプロパティです。このプロパティを使用して、コンテンツページのマスターページをプログラムで指定することもできます。この方法は、ページにアクセスするユーザーなどの外部要因に基づいてマスターページを動的に割り当てる場合に便利です。

このチュートリアルでは、Web サイトに 2 つ目のマスターページを追加し、実行時に使用するマスターページを動的に決定します。

手順 1: ページのライフサイクルの概要

コンテンツページである ASP.NET ページの要求が Web サーバーに到着するたびに、ASP.NET エンジンはページの Content コントロールをマスターページの対応する ContentPlaceHolder コントロールに融合する必要があります。この融合により、一般的なページライフサイクルを進めることができる単一のコントロール階層が作成されます。

図 1 は、この融合を示しています。図 1 の手順 1 は、初期コンテンツとマスターページコントロール階層を示しています。 PreInit ステージの末尾に、ページ内のコンテンツコントロールがマスターページの対応する ContentPlaceHolders に追加されます (手順 2)。この融合後、マスターページは、融合されたコントロール階層のルートとして機能します。その後、この融合コントロール階層がページに追加され、最終的なコントロール階層が生成されます (手順 3)。結果として、ページのコントロール階層には、融合されたコントロール階層が含まれます。

図 01: PreInit ステージ中にマスターページとコンテンツページのコントロール階層が結合されている (フルサイズの画像を表示するをクリックします)

手順 2: コードからプロパティを設定する`MasterPageFile`

この融合のマスターページの部分は、オブジェクトMasterPageFileのプロパティのPage値によって異なります。ディレクティブで属性をMasterPageFile@Page設定すると、ページのライフサイクルの最初のMasterPageFileステージである初期化ステージ中にのプロパティを割り当てるPageという実質的な効果があります。または、プログラムでこのプロパティを設定することもできます。ただし、図 1 の融合が行われる前に、このプロパティを設定することが不可欠です。

PreInit ステージの開始時に、オブジェクトはそのイベントをPage発生させ、そのPreInitメソッドをOnPreInit呼び出します。プログラムでマスターページを設定するには、イベントのイベントハンドラー PreInit を作成するか、メソッドを OnPreInit オーバーライドします。両方のアプローチを見てみましょう。

まず、サイトのホームページの分離コードクラスファイルを開 Default.aspx.csきます。次のコードを入力して、ページのイベントの PreInit イベントハンドラーを追加します。

protected void Page_PreInit(object sender, EventArgs e) 
{ 
}

ここから、プロパティを MasterPageFile 設定できます。値 "~/Site.master" をプロパティに割り当てるようにコードを MasterPageFile 更新します。

protected void Page_PreInit(object sender, EventArgs e) 
{
    this.MasterPageFile = "~/Site.master"; 
}

ブレークポイントを設定してデバッグを開始すると、ページにアクセスするたびにDefault.aspx、またはこのページへのポストバックが発生するたびに、イベントハンドラーが実行されMasterPageFile、Page_PreInitプロパティが "~/Site.master" に割り当てられます。

または、クラスの OnPreInit メソッドをPageオーバーライドし、そこでプロパティをMasterPageFile設定することもできます。この例では、マスターページを特定のページに設定するのではなく、から BasePage設定してみましょう。マスターページのチュートリアルの「タイトル、メタタグ、およびその他の HTML ヘッダーの指定」でカスタム基本ページクラス (BasePage) を作成したことを思い出してください。現在BasePage、クラスの OnLoadComplete メソッドをPageオーバーライドし、サイトマップデータに基づいてページのTitleプロパティを設定します。を更新 BasePage して、メソッドを OnPreInit オーバーライドして、プログラムによってマスターページを指定しましょう。

protected override void OnPreInit(EventArgs e) 
{ 
    this.MasterPageFile = "~/Site.master"; 
    base.OnPreInit(e); 
}

すべてのコンテンツページはから BasePage派生しているため、すべてのコンテンツページにプログラムによってマスターページが割り当てられるようになりました。この時点で、のPreInitDefault.aspx.csイベントハンドラーは余分です。自由に削除してください。

ディレクティブについて`@Page`

少しわかりにくいのは、コンテンツページのMasterPageFileプロパティが 2 つの場所で指定されていることです。クラスの OnPreInit メソッドでBasePageプログラムを使用する方法と、各コンテンツページの @Page ディレクティブの属性を使用MasterPageFileする方法です。

ページライフサイクルの最初のステージは、初期化ステージです。この段階では、Pageオブジェクトの MasterPageFile プロパティにディレクティブ内@Pageの属性のMasterPageFile値が割り当てられます (指定されている場合)。 PreInit ステージは初期化ステージに従い、ここでプログラムでオブジェクトの MasterPageFile プロパティをPage設定し、ディレクティブから割り当てられた値を@Page上書きします。オブジェクトのプロパティを Page プログラムで設定しているため、エンドユーザーの MasterPageFile エクスペリエンスに MasterPageFile 影響を与えることなく、ディレクティブから @Page 属性を削除できます。これを理解するには、内のディレクティブDefault.aspxから属性をMasterPageFile@Page削除し、ブラウザーからページにアクセスします。予想どおり、出力は属性が削除される前と同じです。

プロパティがディレクティブを MasterPageFile 使用して @Page 設定されているか、プログラムによって設定されるかは、エンドユーザーのエクスペリエンスに関係なく行われます。ただし、ディレクティブの MasterPageFile@Page 属性は、デザイン時に Visual Studio によって使用され、Designerで WYSIWYG ビューが生成されます。 Visual Studio でにDefault.aspx戻り、Designerに移動すると、"マスターページエラー: ページにはマスターページ参照を必要とするコントロールがありますが、何も指定されていない" というメッセージが表示されます (図 2 を参照)。

つまり、Visual Studio で豊富なデザイン時エクスペリエンスを@Page実現するには、ディレクティブに属性を残すMasterPageFile必要があります。

Visual Studio では、<span class= @Page ディレクティブの MasterPageFile 属性を使用してデザインビューをレンダリングします" />

図 02: Visual Studio はディレクティブの MasterPageFile 属性を@Page使用してデザインビューをレンダリングします (フルサイズの画像を表示する場合はクリックします)

手順 3: 代替マスターページを作成する

コンテンツページのマスターページは実行時にプログラムで設定できるため、外部条件に基づいて特定のマスターページを動的に読み込むことができます。この機能は、サイトのレイアウトがユーザーによって異なる必要がある状況で役立ちます。たとえば、ブログエンジン Web アプリケーションでは、各レイアウトが異なるマスターページに関連付けられているブログのレイアウトをユーザーが選択できる場合があります。実行時に、訪問者がユーザーのブログを表示している場合、Web アプリケーションはブログのレイアウトを決定し、対応するマスターページをコンテンツページに動的に関連付ける必要があります。

いくつかの外部条件に基づいて、実行時にマスターページを動的に読み込む方法を見てみましょう。現在、この Web サイトにはマスターページSite.master () が 1 つだけ含まれています。実行時にマスターページを選択する方法を示すために、別のマスターページが必要です。この手順では、新しいマスターページの作成と構成に焦点を当てます。手順 4 では、実行時に使用するマスターページを決定する方法について説明します。

という名前 Alternate.masterのルートフォルダーに新しいマスターページを作成します。また、という名前 AlternateStyles.cssの Web サイトに新しいスタイルシートを追加します。

図 03: Web サイトに別のマスターページと CSS ファイルを追加する (フルサイズの画像を表示するをクリックします)

マスターページを Alternate.master デザインして、タイトルがページの上部に表示され、中央に配置され、海軍の背景に表示されるようにしました。左側の列を調べ、そのコンテンツを ContentPlaceHolder コントロールの下 MainContent に移動しました。これはページの幅全体にまたがっています。さらに、順序付けられていないレッスンリストを作成し、上 MainContentの水平リストに置き換えました。また、マスターページで使用されるフォントと色も更新しました (また、拡張によって、そのコンテンツページ)。図 4 は、マスターページを使用する場合をAlternate.master示していますDefault.aspx。

注意

ASP.NET には 、テーマを定義する機能が含まれています。 Theme は、実行時にページに適用できる画像、CSS ファイル、およびスタイル関連の Web コントロールプロパティ設定のコレクションです。テーマは、サイトのレイアウトが表示される画像と CSS ルールによってのみ異なる場合に行く方法です。異なる Web コントロールの使用や、レイアウトが大幅に異なるなど、レイアウトが大幅に異なる場合は、個別のマスターページを使用する必要があります。テーマの詳細については、このチュートリアルの最後にある「さらに読む」セクションを参照してください。

図 04: コンテンツページで新しい外観を使用できるようになりました (クリックするとフルサイズの画像が表示されます)

マスターページとコンテンツページのマークアップが融合されると、 MasterPage クラスは、コンテンツページ内のすべてのコンテンツコントロールがマスターページの ContentPlaceHolder を参照していることを確認します。存在しない ContentPlaceHolder を参照する Content コントロールが見つかった場合、例外がスローされます。言い換えると、コンテンツページに割り当てられているマスターページには、コンテンツページ内のコンテンツコントロールごとに ContentPlaceHolder が必要です。

Site.masterマスターページには、次の 4 つの ContentPlaceHolder コントロールが含まれています。

head
MainContent
QuickLoginUI
LeftColumnContent

当社のウェブサイトのコンテンツページの一部には、1つまたは2つのコンテンツコントロールが含まれています。他のユーザーには、使用可能な各 ContentPlaceHolders の Content コントロールが含まれます。すべての ContentPlaceHolders Site.master のコンテンツコントロールを持つコンテンツページに新しいマスターページ (Alternate.master) を割り当てることができる場合は、と同じ ContentPlaceHolder コントロールSite.masterも含める必要がありますAlternate.master。

マスターページを Alternate.master 自分のページに似た外観にするには (図 4 を参照)、まずスタイルシートでマスターページのスタイルを AlternateStyles.css 定義します。に次の規則を AlternateStyles.css追加します。

body 
{ 
 font-family: Comic Sans MS, Arial; 
 font-size: medium; 
 margin: 0px; 
} 
#topContent 
{ 
 text-align: center; 
 background-color: Navy; 
 color: White; 
 font-size: x-large;
 text-decoration: none; 
 font-weight: bold; 
 padding: 10px; 
 height: 50px;
} 
#topContent a 
{ 
 text-decoration: none; 
 color: White; 
} 
#navContent 
{ 
 font-size: small; 
 text-align: center; 
} 
#footerContent 
{ 
 padding: 10px; 
 font-size: 90%; 
 text-align: center; 
 border-top: solid 1px black; 
} 
#mainContent 
{ 
 text-align: left; 
 padding: 10px; 
}

次に、次の宣言型マークアップをに追加します Alternate.master。ご覧のように、には、 Alternate.master の ContentPlaceHolder コントロールと同じ ID 値を持つ 4 つの ContentPlaceHolder コントロールが Site.master含まれています。さらに、ASP.NET AJAX フレームワークを使用する Web サイトのページに必要な ScriptManager コントロールも含まれています。

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
<html xmlns="http://www.w3.org/1999/xhtml"> 
<head id="Head1" runat="server"> 
 <title>Untitled Page</title>
 <asp:ContentPlaceHolder id="head" runat="server">
 </asp:ContentPlaceHolder> 
 <link href="AlternateStyles.css" rel="stylesheet" type="text/css" /> 
</head> 
<body> 
 <form id="form1" runat="server"> 
 <asp:ScriptManager ID="MyManager" runat="server"> 
 </asp:ScriptManager>
 <div id="topContent">
 <asp:HyperLink ID="lnkHome" runat="server" NavigateUrl="~/Default.aspx" 
 Text="Master Pages Tutorials" /> 
 </div>
 <div id="navContent">
 <asp:ListView ID="LessonsList" runat="server" 
 DataSourceID="LessonsDataSource">
 <LayoutTemplate>
 <asp:PlaceHolder runat="server" ID="itemPlaceholder" /> 
 </LayoutTemplate>
 <ItemTemplate>
 <asp:HyperLink runat="server" ID="lnkLesson" 
 NavigateUrl='<%# Eval("Url") %>' 
 Text='<%# Eval("Title") %>' /> 
 </ItemTemplate>
 <ItemSeparatorTemplate> | </ItemSeparatorTemplate> 
 </asp:ListView>
 <asp:SiteMapDataSource ID="LessonsDataSource" runat="server" 
 ShowStartingNode="false" /> 
 </div>
 <div id="mainContent">
 <asp:ContentPlaceHolder id="MainContent" runat="server"> 
 </asp:ContentPlaceHolder>
 </div> 
 <div id="footerContent">
 <p> 
 <asp:Label ID="DateDisplay" runat="server"></asp:Label> 
 </p>
 <asp:ContentPlaceHolder ID="QuickLoginUI" runat="server"> 
 </asp:ContentPlaceHolder>
 <asp:ContentPlaceHolder ID="LeftColumnContent" runat="server"> 
 </asp:ContentPlaceHolder>
 </div> 
 </form>
</body> 
</html>

新しいマスターページのテスト

この新しいマスターページをBasePageテストするには、プロパティに値 "~/Alternate.master" が割り当てるようにMasterPageFileクラスのOnPreInitメソッドを更新し、Web サイトにアクセスします。との 2 つ ~/Admin/AddProduct.aspx~/Admin/Products.aspxを除き、すべてのページがエラーなしで機能する必要があります。で DetailsView ~/Admin/AddProduct.aspx に製品を追加すると NullReferenceException 、マスターページ GridMessageText のプロパティの設定を試みるコード行からが作成されます。にアクセス~/Admin/Products.aspxInvalidCastExceptionすると、"型 'ASP.alternate_master' のオブジェクトを型 'ASP.site_master' にキャストできません" というメッセージが表示されたページ読み込み時にスローされます。

これらのエラーは、分離コードクラスに Site.master 、で定義されていないパブリックイベント、プロパティ、およびメソッドが含まれているために Alternate.master発生します。これら 2 つのページのマークアップ部分には、マスターページを @MasterType 参照するディレクティブがあります Site.master 。

<%@ MasterType VirtualPath="~/Site.master" %>

また、の DetailsView の ItemInserted イベントハンドラー ~/Admin/AddProduct.aspx には、緩やかに型指定された Page.Master プロパティを型 Siteのオブジェクトにキャストするコードが含まれています。 @MasterTypeディレクティブ (この方法で使用) とイベントハンドラーのItemInsertedキャストは、ページと ~/Admin/Products.aspx ページを~/Admin/AddProduct.aspxマスターページに密にSite.master結合します。

この緊密な結合を解除するために、パブリックメンバーの定義を含む共通の基底クラスを持ちSite.masterAlternate.master、そこから派生させることができます。その後、ディレクティブを更新して、 @MasterType この一般的な基本型を参照できます。

カスタム基本マスターページクラスの作成

という名前BaseMasterPage.csのフォルダーに新しいクラスファイルをApp_Code追加し、からSystem.Web.UI.MasterPage派生させます。ではメソッドとプロパティBaseMasterPageをRefreshRecentProductsGridGridMessageText定義する必要がありますが、これらのメンバーはマスターページ (RecentProductsGridView と GridMessage Label) にSite.master固有の Web コントロールを使用するため、そこから移動Site.masterすることはできません。

必要なのは、これらのメンバーがそこで定義されるように構成BaseMasterPageすることですが、実際にはの派生クラス (Site.master と Alternate.master) によってBaseMasterPage実装されます。この種類の継承は、クラスとそのメンバーをとして abstractマークすることで可能です。要するにabstract、これら 2 つのメンバーにキーワード (keyword)を追加すると、実装されていない RefreshRecentProductsGrid と GridMessageTextが読み上BaseMasterPageげられるが、その派生クラスはと読み上げられる。

また、でBaseMasterPageイベントをPricesDoubled定義し、派生クラスによってイベントを発生させる手段を提供する必要があります。この動作を容易にするために.NET Frameworkで使用されるパターンは、基底クラスにパブリックイベントを作成し、 virtual という名前OnEventNameの保護されたメソッドを追加することです。その後、派生クラスは、このメソッドを呼び出してイベントを発生させたり、イベントが発生する直前または直後にコードを実行するようにオーバーライドしたりできます。

次のコードが含まれるようにクラスを更新します BaseMasterPage 。

using System; public abstract class BaseMasterPage : System.Web.UI.MasterPage
{ 
    public event EventHandler PricesDoubled; 
    protected virtual void OnPricesDoubled(EventArgs e) 
    { 
        if (PricesDoubled != null) 
        PricesDoubled(this, e); 
    } 
    public abstract void RefreshRecentProductsGrid();
    public abstract string GridMessageText 
    { 
        get; 
        set; 
    } 
}

次に、分離コードクラスに Site.master 移動し、から BaseMasterPage派生させます。では、 abstract でSite.masterこれらのabstractメンバーをオーバーライドする必要があるためBaseMasterPageです。メソッドとプロパティのoverride定義にキーワード (keyword)を追加します。また、基本クラスOnPricesDoubledのメソッドのPricesDoubled呼び出しを使用して、DoublePriceButton のClickイベントハンドラーでイベントを発生させるコードを更新します。

これらの変更の後、 Site.master 分離コードクラスには次のコードを含める必要があります。

public partial class Site : BaseMasterPage { 
    protected void Page_Load(object sender, EventArgs e) 
    { 
        DateDisplay.Text = DateTime.Now.ToString("dddd, MMMM dd"); 
    } 
    public override void RefreshRecentProductsGrid()
    { 
        RecentProducts.DataBind();
    } 
    public override string GridMessageText
    { 
        get 
        {
            return GridMessage.Text;
        } 
        set
        {
            GridMessage.Text = value; 
        } 
    }
    protected void DoublePrice_Click(object sender, EventArgs e) 
    { 
        // Double the prices 
        DoublePricesDataSource.Update();
        // Refresh RecentProducts 
        RecentProducts.DataBind();
        // Raise the PricesDoubled event
        base.OnPricesDoubled(EventArgs.Empty);
    } 
}

また、2 つのabstractメンバーからBaseMasterPage派生してオーバーライドするために、の分離コードクラスを更新Alternate.masterする必要があります。ただし、最新の製品を一覧表示する GridView や、新しい製品がデータベースに追加された後にメッセージを表示する Label が含まれていないため Alternate.master 、これらのメソッドは何もする必要はありません。

public partial class Alternate : BaseMasterPage 
{ 
    public override void RefreshRecentProductsGrid() 
    { 
        // Do nothing 
    } 
    public override string GridMessageText 
    { 
        get
        { 
            return string.Empty;
        } 
        set
        {
            // Do nothing 
        } 
    }
}

基本マスターページクラスの参照

クラスをBaseMasterPage完了し、2 つのマスターページを拡張したので、最後の手順では、ページと ~/Admin/Products.aspx ページを更新~/Admin/AddProduct.aspxして、この一般的な型を参照します。最初に、両方のページのディレクティブを @MasterType 次から変更します。

<%@ MasterType VirtualPath="~/Site.master" %>

移動先:

<%@ MasterType TypeName="BaseMasterPage" %>

プロパティは、ファイルパスを参照するのではなく、 @MasterType 基本型 (BaseMasterPage) を参照するようになりました。したがって、両方のページの分離コードクラスで使用される厳密に型指定されたMasterプロパティは、型ではなく型BaseMasterPageSiteになりました。この変更に伴い、を再検討してください ~/Admin/Products.aspx。以前は、ページがマスターページを使用Alternate.masterするように構成されていますが、ディレクティブがファイルを参照Site.masterしているため、@MasterTypeキャストエラーが発生しました。しかし、ページがエラーなしでレンダリングされるようになりました。これは、マスターページを型BaseMasterPageのAlternate.masterオブジェクトにキャストできるためです (拡張されているため)。

で行 ~/Admin/AddProduct.aspxう必要がある小さな変更が 1 つあります。 DetailsView コントロールの ItemInserted イベントハンドラーでは、厳密に型指定されたプロパティと緩やかに型指定された Master プロパティの両方が使用されます Page.Master 。ディレクティブを更新したときに厳密に型指定された参照を @MasterType 修正しましたが、緩やかに型指定された参照を更新する必要があります。次のコード行を置き換えます。

Site myMasterPage = Page.Master as Site;

基本型にキャスト Page.Master する次のを使用します。

BaseMasterPage myMasterPage = Page.Master as BaseMasterPage;

手順 4: コンテンツページにバインドするマスターページを決定する

現在、このクラスは BasePage 、ページライフサイクルの MasterPageFile PreInit ステージで、すべてのコンテンツページのプロパティをハードコーディングされた値に設定しています。このコードを更新して、何らかの外部要素に基づいてマスターページを作成できます。読み込むマスターページは、現在ログオンしているユーザーの設定によって異なる場合があります。その場合は、メソッドBasePageでOnPreInit、現在アクセスしているユーザーのマスターページ設定を検索するコードを記述する必要があります。

使用するマスターページ (またはAlternate.master) をユーザーが選択できる Web ページをSite.master作成し、この選択内容を Session 変数に保存してみましょう。まず、という名前 ChooseMasterPage.aspxのルートディレクトリに新しい Web ページを作成します。このページ (またはそれ以降の他のコンテンツページ) を作成する場合、マスターページはでプログラムによって設定されるため、マスターページに BasePageバインドする必要はありません。ただし、新しいページをマスターページにバインドしない場合、新しいページの既定の宣言型マークアップには、Web フォームと、マスターページによって提供されるその他のコンテンツが含まれます。このマークアップを適切なコンテンツコントロールに手動で置き換える必要があります。そのため、新しい ASP.NET ページをマスターページにバインドする方が簡単です。

注意

と Alternate.master には ContentPlaceHolder コントロールのセットが同じであるためSite.master、新しいコンテンツページを作成するときに選択するマスターページは関係ありません。一貫性を保つには、を使用 Site.masterすることをお勧めします。

図 05: Web サイトに新しいコンテンツページを追加する (フルサイズの画像を表示するをクリックします)

このレッスンの Web.sitemap エントリを含むようにファイルを更新します。マスターページのの下 <siteMapNode> に次のマークアップを追加し、AJAX レッスン ASP.NET します。

<siteMapNode url="~/ChooseMasterPage.aspx" title="Choose a Master Page" />

ページにコンテンツを追加するChooseMasterPage.aspx前に、ページの分離コードクラスを (ではなくSystem.Web.UI.Page) からBasePage派生するように更新します。次に、DropDownList コントロールをページに追加し、そのプロパティを ID に MasterPageChoice設定し、"~/Site.master" と "~/Alternate.master" の値を持つ Text 2 つの ListItems を追加します。

Button Web コントロールをページに追加し、その ID プロパティと Text プロパティをそれぞれ SaveLayout に設定し、それぞれ "レイアウトの選択を保存" に設定します。この時点で、ページの宣言型マークアップは次のようになります。

<p> 
 Your layout choice: 
 <asp:DropDownList ID="MasterPageChoice" runat="server"> 
 <asp:ListItem>~/Site.master</asp:ListItem>
 <asp:ListItem>~/Alternate.master</asp:ListItem>
 </asp:DropDownList> 
</p> 
<p> 
 <asp:Button ID="SaveLayout" runat="server" Text="Save Layout Choice" /> 
</p>

ページに初めてアクセスするときは、ユーザーが現在選択しているマスターページの選択肢を表示する必要があります。イベントハンドラーを Page_Load 作成し、次のコードを追加します。

protected void Page_Load(object sender, EventArgs e) 
{ 
    if (!Page.IsPostBack) 
    { 
        if (Session["MyMasterPage"] != null)
        {
            ListItem li = MasterPageChoice.Items.FindByText(Session["MyMasterPage"].ToString());
            if (li != null) 
                li.Selected = true; 
        } 
    }
}

上記のコードは、最初のページアクセスでのみ実行されます (後続のポストバックでは実行されません)。最初に、Session 変数 MyMasterPage が存在するかどうかを確認します。その場合は、DropDownList で一致する ListItem を MasterPageChoice 検索しようとします。一致する ListItem が見つかった場合、その Selected プロパティはに true設定されます。

また、ユーザーの選択を Session 変数に保存する MyMasterPage コードも必要です。 Button のイベントのイベントハンドラーを SaveLayout 作成し、次の Click コードを追加します。

protected void SaveLayout_Click(object sender, EventArgs e)
{
    Session["MyMasterPage"] = MasterPageChoice.SelectedValue;
    Response.Redirect("ChooseMasterPage.aspx"); 
}

注意

イベントハンドラーが Click ポストバックで実行される頃には、マスターページは既に選択されています。したがって、ユーザーのドロップダウンリストの選択は、次のページにアクセスするまで有効になりません。は Response.Redirect 、ブラウザーにを強制的に要求 ChooseMasterPage.aspxします。

ページが ChooseMasterPage.aspx 完了したら、最後のタスクは BasePage Session 変数の MasterPageFile 値に基づいてプロパティを MyMasterPage 割り当てることです。 Session 変数がに設定されていない場合、既定値は BasePage に Site.master設定されます。

protected override void OnPreInit(EventArgs e) 
{ 
    SetMasterPageFile();
    base.OnPreInit(e); 
} 
protected virtual void SetMasterPageFile()
{ 
    this.MasterPageFile = GetMasterPageFileFromSession();
} 
protected string GetMasterPageFileFromSession() 
{ 
    if (Session["MyMasterPage"] == null) 
        return "~/Site.master";
    else
        return Session["MyMasterPage"].ToString(); 
}

注意

オブジェクトMasterPageFileのプロパティを割り当てるコードをPageイベントハンドラーから OnPreInit 2 つの異なるメソッドに移動しました。この最初のメソッドは、 SetMasterPageFileプロパティを MasterPageFile 2 番目のメソッド GetMasterPageFileFromSession() によって返される値に割り当てます。必要に応じて、拡張する将来のSetMasterPageFileクラスがBasePage必要に応じてそれをオーバーライドしてカスタムロジックを実装できるように、メソッドvirtualを作成しました。次のチュートリアルでは、のプロパティをオーバーライドするBasePageSetMasterPageFile例を示します。

このコードを配置した状態で、ページにアクセスします ChooseMasterPage.aspx 。最初はマスターページが Site.master 選択されていますが (図 6 を参照)、ユーザーはドロップダウンリストから別のマスターページを選択できます。

図 06: マスターページを使用してコンテンツページが Site.master 表示される (フルサイズの画像を表示するをクリックします)

図 07: マスターページを使用してコンテンツページが Alternate.master 表示されるようになりました (クリックするとフルサイズの画像が表示されます)

まとめ

コンテンツページにアクセスすると、そのコンテンツコントロールはマスターページの ContentPlaceHolder コントロールと融合されます。コンテンツページのマスターページは、クラスのプロパティによってPage示されます。このプロパティは、初期化ステージ中に @Page ディレクティブの MasterPageFile 属性に割り当MasterPageFileてられます。このチュートリアルで示したように、PreInit ステージの MasterPageFile 終了前であれば、プロパティに値を割り当てることができます。プログラムでマスターページを指定できることで、外部要因に基づいてコンテンツページをマスターページに動的にバインドするなど、より高度なシナリオの扉が開きます。

プログラミングに満足!

もっと読む

このチュートリアルで説明するトピックの詳細については、次のリソースを参照してください。

著者について

複数の ASP/ASP.NET 書籍の著者であり、4GuysFromRolla.com の創設者である Scott Mitchell は、1998 年から Microsoft Web テクノロジと協力しています。 Scott は、独立したコンサルタント、トレーナー、ライターとして働いています。彼の最新の本は サムズ・ティーチ・自分自身 ASP.NET 24時間で3.5です。 Scott は、または mitchell@4GuysFromRolla.com のブログから http://ScottOnWriting.NETアクセスできます。

特別な感謝

このチュートリアルシリーズは、多くの役に立つ校閲者によってレビューされました。このチュートリアルのリードレビュー担当者は、Suchi Banerjee でした。今後の MSDN の記事を確認することに関心がありますか? もしそうなら、私に行を落としてください mitchell@4GuysFromRolla.com

前へ次へ

次の方法で共有

プログラムでマスターページを指定する (C#)

はじめに

手順 1: ページのライフサイクルの概要

手順 2: コードからプロパティを設定する`MasterPageFile`

ディレクティブについて`@Page`

手順 3: 代替マスターページを作成する

新しいマスターページのテスト

カスタム基本マスターページクラスの作成

基本マスターページクラスの参照

手順 4: コンテンツページにバインドするマスターページを決定する

まとめ

もっと読む

著者について

特別な感謝

フィードバック

フィードバック

その他のリソース

次の方法で共有

プログラムでマスター ページを指定する (C#)

はじめに

手順 1: ページのライフサイクルの概要

手順 2: コードからプロパティを設定するMasterPageFile

ディレクティブについて@Page

手順 3: 代替マスター ページを作成する

新しいマスター ページのテスト

カスタム 基本マスター ページ クラスの作成

基本マスター ページ クラスの参照

手順 4: コンテンツ ページにバインドするマスター ページを決定する

まとめ

もっと読む

著者について

特別な感謝

フィードバック

フィードバック

その他のリソース

プログラムでマスターページを指定する (C#)

手順 2: コードからプロパティを設定する`MasterPageFile`

ディレクティブについて`@Page`

手順 3: 代替マスターページを作成する

新しいマスターページのテスト

カスタム基本マスターページクラスの作成

基本マスターページクラスの参照

手順 4: コンテンツページにバインドするマスターページを決定する