.NET TIPS

[ASP.NET]コンテンツ・ページからマスター・ページの情報に簡単にアクセスするには?[2.0のみ、C#、VB]

山田 祥寛
2006/07/07

 「TIPS:[ASP.NET]サイト共通のヘッダ/フッタを一元管理するには?」でも紹介したように、ASP.NET 2.0ではマスター・ページを利用することで、サイト共通レイアウトの管理が簡単に行えるようになった。

 もっとも、前掲のTIPSの方法では、マスター・ページ上のコンテンツにアクセスするために、Page.MasterプロパティからMasterPageオブジェクト(System.Web.UI名前空間)を取得した後、FindControlメソッドで対象のコントロールを検索し、さらにこれを適切な型へキャストする必要があるなど、煩雑な手続きが要求される。

 コンテンツ・ページから操作したいマスター・ページ上の項目が多岐にわたる場合や、コンテンツ・ページからのアクセスが頻繁に発生する場合、その都度、このようなコードを記述するのは、開発者にとってはやはりうれしくないものだ。そこで、コンテンツ・ページの側で頻繁に利用するような情報については、その項目をマスター・ページでパブリック・プロパティとして公開しておくことで、アクセスの手続きを省力化させると便利だ。

 例えば、以下のコードはマスター・ページMyMaster.master(前掲のTIPS参照)に配置されたLabelコントロール「lblHeader」の値を、MyTaglineプロパティ(書き込み専用)として公開した例である。

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class MyMaster : System.Web.UI.MasterPage {
  public String MyTagline
  {
    set { lblHeader.Text = value; }
  }
}
Partial Class myMaster
  Inherits System.Web.UI.MasterPage
  Public WriteOnly Property MyTagline() As String
    Set(ByVal value As String)
      lblHeader.Text = value
    End Set
  End Property
End Class
マスター・ページ上のコントロール値をプロパティとして公開する例(上:C#版、下:VB版)

 もちろん、プロパティとしてLabelコントロールへの参照そのものを公開しても(構文上は)問題ない。しかし、アクセスしたい情報があらかじめ想定できているならば、隠ぺい性という観点からもアクセスの必要がある情報に限定して公開する方がより好ましいだろう。

 一方、マスター・ページで公開されたプロパティに対して、コンテンツ・ページからアクセスするには、「.aspx」ファイルおよび「.aspx.vb」「.aspx.cs」ファイルを以下のように記述する必要がある。

<%@ Page masterPageFile="~/MyMaster.master" ... %>
<%@ MasterType VirtualPath="~/MyMaster.master" %>
マスター・ページ上のパブリック・プロパティにアクセスするための宣言(Contents.aspx)
 
using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class Contents : System.Web.UI.Page {
  protected void Page_Load(object sender, EventArgs e) {
    Master.MyTagline = "コンテンツページです";
  }
}
Partial Class Contents
  Inherits System.Web.UI.Page

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
    Master.MyTagline = "コンテンツページです"
  End Sub
End Class
マスター・ページ上のパブリック・プロパティにアクセスするコード(上:C#版、下:VB版)

 ここでポイントとなるのは、.aspxファイルでの@MasterTypeディレクティブだ。@MasterTypeディレクティブを使うことで厳密にマスター・ページを型指定することができる(マスター・ページを示すPage.Masterプロパティの型がマスター・ページの実際の型となる)。VirtualPath属性には、厳密な型を生成する「.master」ファイルへのパスを指定すればよい。

 あとは、Page.Masterプロパティを介して取得した厳密に型指定されたMasterPageオブジェクト(実際にはMasterPage派生クラスのオブジェクト)を取得し、これを介してプロパティにアクセスするだけだ。前掲のTIPSで紹介したFindControlメソッドを利用する場合に比べ、シンプルなコードでマスター・ページ上のコンテンツにアクセスできることがお分かりいただけるはずだ。

 以上を理解したら、さっそくContents.aspxを実行してみよう。実行した結果、前掲のTIPSで得たのと同様に、以下のようなページが表示されれば成功だ。

マスター・ページを適用したコンテンツ・ページの実行結果

 実行結果では、マスター・ページ上のContentPlaceHolderコントロール(プレイスホルダ)に各ページのコンテンツが埋め込まれる。End of Article 

利用可能バージョン:.NET Framework 2.0のみ
カテゴリ:Webフォーム 処理対象:マスター・ページ
使用キーワード:@Masterディレクティブ
使用ライブラリ:MasterPageクラス(System.Web.UI名前空間)
使用ライブラリ:ContentPlaceHolderクラス(System.Web.UI.WebControls名前空間)
関連TIPS:TIPS:[ASP.NET]サイト共通のヘッダ/フッタを一元管理するには?

この記事と関連性の高い別の.NET TIPS
[ASP.NET]サイト共通のヘッダ/フッタを一元管理するには?
[ASP.NET MVC]ASP.NET MVCでマスター・ページを適用するには?
[ASP.NET]ページのタイトルやメタ情報を動的に変更するには?
[ASP.NET]ページ間ポストバックでポスト元ページの情報に簡単にアクセスするには?
[ASP.NET]ナビゲーションAPIで前後ページへのナビゲーション・バーを作成するには?
このリストは、(株)デジタルアドバンテージが開発した
自動関連記事探索システム Jigsaw(ジグソー) により自動抽出したものです。
generated by

「.NET TIPS」

@IT Special

- PR -

TechTargetジャパン

Insider.NET フォーラム 新着記事
  • 第2回 簡潔なコーディングのために (2017/7/26)
     ラムダ式で記述できるメンバの増加、throw式、out変数、タプルなど、C# 7には以前よりもコードを簡潔に記述できるような機能が導入されている
  • 第1回 Visual Studio Codeデバッグの基礎知識 (2017/7/21)
     Node.jsプログラムをデバッグしながら、Visual Studio Codeに統合されているデバッグ機能の基本の「キ」をマスターしよう
  • 第1回 明瞭なコーディングのために (2017/7/19)
     C# 7で追加された新機能の中から、「数値リテラル構文の改善」と「ローカル関数」を紹介する。これらは分かりやすいコードを記述するのに使える
  • Presentation Translator (2017/7/18)
     Presentation TranslatorはPowerPoint用のアドイン。プレゼンテーション時の字幕の付加や、多言語での質疑応答、スライドの翻訳を行える
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)
- PR -

イベントカレンダー

PickUpイベント

- PR -

アクセスランキング

もっと見る

ホワイトペーパーTechTargetジャパン

注目のテーマ

Insider.NET 記事ランキング

本日 月間
ソリューションFLASH