TagPrefixInfo

.NET Framework クラス ライブラリ リファレンス

TagPrefixInfo クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

タグ関連情報が格納される構成要素を定義します。

名前空間: System.Web.Configuration
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 TagPrefixInfo
    Inherits ConfigurationElement

Visual Basic (使用法)

Dim instance As TagPrefixInfo

C#

public sealed class TagPrefixInfo : ConfigurationElement

C++

public ref class TagPrefixInfo sealed : public
 ConfigurationElement

J#

public final class TagPrefixInfo extends ConfigurationElement

JScript

public final class TagPrefixInfo extends
 ConfigurationElement

解説

TagPrefixInfo クラスを使用すると、構成ファイルに格納されているタグ プリフィックス情報にプログラムからアクセスして変更できます。このクラスは、ASP.NET の @Register ディレクティブと同じ機能を提供します。タグ プリフィックスは、ASP.NET の「名前空間」を、カスタム コントロールとユーザー コントロールが適切に動作するために必要なアセンブリと名前空間に関連付けます。TagPrefixInfo オブジェクトは、TagPrefixCollection オブジェクトのメンバとして格納されます。TagPrefixCollection クラスを使用すると、構成ファイル内の pages セクションの controls サブセクションにプログラムからアクセスして変更できます。

TagPrefixInfo オブジェクトは、add 要素を使用して、tagPrefix 属性とその他の関連する属性に値を指定することによって、コレクションに追加されます。その他の必要な情報は、指定のタグ プリフィックスで使用するコンロトールの種類によって異なります。

• ユーザー コントロールの場合、TagPrefix、TagName、および Source の各プロパティを定義する必要があります。

• カスタム コントロールの場合、TagPrefix、Namespace、および Assembly の各プロパティを定義する必要があります。Assembly プロパティは、そのコントロールがアプリケーション コード ディレクトリ内にある場合には必要ありません。

同じ tagPrefix 値を複数のアセンブリまたは名前空間に割り当てることができます。

メモ
ソースが指定される場合、ユーザー コントロールそのものはページと同じディレクトリに存在できません。ページと同じディレクトリに存在する場合、ページの読み込み時にランタイム エラーが発生します。

使用例

この例では、controls セクションの複数の属性に対して、宣言によって値を指定する方法を示しています。これらの属性には、TagPrefixInfo クラスのメンバとしてもアクセスできます。

<system.web>
  <pages>
    <controls>
      <!—- Searches all linked assemblies for the namespace -->
      <add tagPrefix="MyTags1" namespace=" MyNameSpace "/>
      <!-- Uses a specified assembly -->
      <add tagPrefix="MyTags2" namespace="MyNameSpace" 
        assembly="MyAssembly"/>
      <!-- Uses the specified source for the user control -->
      <add tagprefix="MyTags3" tagname="MyCtrl" src="https://cdn.weblio.jp/e7/img/dict/msdnc/MyControl.ascx"/>
    </controls>
   </pages>
</system.web>

TagPrefixInfo クラスを使用して、プログラムからタグ プリフィックス設定を変更する方法を次のコード例に示します。このコード例は、PagesSection クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' Get all current Controls in the collection.
Dim j As Int32
For j = 0 To pagesSection.Controls.Count -
 1
  Console.WriteLine("Control {0}:", j)
  Console.WriteLine("  TagPrefix = '{0}' ", _
   pagesSection.Controls(j).TagPrefix)
  Console.WriteLine("  TagName = '{0}' ", _
   pagesSection.Controls(j).TagName)
  Console.WriteLine("  Source = '{0}' ", _
   pagesSection.Controls(j).Source)
  Console.WriteLine("  Namespace = '{0}' ",
 _
   pagesSection.Controls(j).Namespace)
  Console.WriteLine("  Assembly = '{0}' ",
 _
   pagesSection.Controls(j).Assembly)
Next

' Create a new TagPrefixInfo object.
Dim tagPrefixInfo As System.Web.Configuration.TagPrefixInfo
 = _
 New System.Web.Configuration.TagPrefixInfo("MyCtrl",
 "MyNameSpace", "MyAssembly",
 "MyControl", "MyControl.ascx")

' Execute the Add Method.
pagesSection.Controls.Add(tagPrefixInfo)

' Add a TagPrefixInfo object using a constructor.
pagesSection.Controls.Add( _
 New System.Web.Configuration.TagPrefixInfo( _
 "MyCtrl", "MyNameSpace",
 "MyAssembly", "MyControl",
 _
 "MyControl.ascx"))

C#

// Get all current Controls in the collection.
for (int i = 0; i < pagesSection.Controls.Count;
 i++)
{
  Console.WriteLine("Control {0}:", i);
  Console.WriteLine("  TagPrefix = '{0}' ",
      pagesSection.Controls[i].TagPrefix);
  Console.WriteLine("  TagName = '{0}' ",
      pagesSection.Controls[i].TagName);
  Console.WriteLine("  Source = '{0}' ",
      pagesSection.Controls[i].Source);
  Console.WriteLine("  Namespace = '{0}' ",
      pagesSection.Controls[i].Namespace);
  Console.WriteLine("  Assembly = '{0}' ",
      pagesSection.Controls[i].Assembly);
}

// Create a new TagPrefixInfo object.
System.Web.Configuration.TagPrefixInfo tagPrefixInfo =
    new System.Web.Configuration.TagPrefixInfo("MyCtrl",
 "MyNameSpace", "MyAssembly", "MyControl", "MyControl.ascx");

// Execute the Add Method.
pagesSection.Controls.Add(tagPrefixInfo);

// Add a TagPrefixInfo object using a constructor.
pagesSection.Controls.Add(
    new System.Web.Configuration.TagPrefixInfo(
    "MyCtrl", "MyNameSpace", "MyAssembly", "MyControl"
,
    "MyControl.ascx"));

継承階層

System.Object
   System.Configuration.ConfigurationElement
    System.Web.Configuration.TagPrefixInfo

スレッド セーフ

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

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
TagPrefixInfo メンバ
System.Web.Configuration 名前空間
PagesSection クラス
TagPrefixCollection クラス
その他の技術情報
pages 要素 (ASP.NET 設定スキーマ)
pages の controls 要素 (ASP.NET 設定スキーマ)

TagPrefixInfo コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

渡された値を使用して、TagPrefixInfo クラスの新しいインスタンスを初期化します。

名前空間: System.Web.Configuration
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    tagPrefix As String, _
    nameSpace As String,
 _
    assembly As String,
 _
    tagName As String, _
    source As String _
)

Visual Basic (使用法)

Dim tagPrefix As String
Dim nameSpace As String
Dim assembly As String
Dim tagName As String
Dim source As String

Dim instance As New TagPrefixInfo(tagPrefix,
 nameSpace, assembly, tagName, source)

C#

public TagPrefixInfo (
    string tagPrefix,
    string nameSpace,
    string assembly,
    string tagName,
    string source
)

C++

public:
TagPrefixInfo (
    String^ tagPrefix, 
    String^ nameSpace, 
    String^ assembly, 
    String^ tagName, 
    String^ source
)

J#

public TagPrefixInfo (
    String tagPrefix, 
    String nameSpace, 
    String assembly, 
    String tagName, 
    String source
)

JScript

public function TagPrefixInfo (
    tagPrefix : String, 
    nameSpace : String, 
    assembly : String, 
    tagName : String, 
    source : String
)

パラメータ

tagPrefix

ソース ファイル、または名前空間とアセンブリに割り当てられるタグ プリフィックス。

nameSpace

タグ プリフィックスに関連付ける名前空間。

assembly

名前空間が存在するアセンブリ。

tagName

ページ内で使用するコントロールの名前。

source

ユーザー コントロールを含むファイルの名前。

解説

このコンストラクタは、渡されたパラメータを使用して、TagPrefixInfo クラスのインスタンスを作成して初期化します。値を指定するパラメータは、指定のタグ プリフィックスで参照するコントロールの種類によって異なります。そのプリフィックスで必要のないパラメータは空白のままにします。つまり、空の文字列を使用します。

• コントロールがユーザー コントロールの場合、tagPrefix、tagName、および source の各プロパティに値を指定する必要があります。

• コントロールがカスタム コントロールの場合、tagPrefix プロパティと nameSpace プロパティに値を指定する必要があります。コントロールがアプリケーション コード ディレクトリ内にない場合は、assembly パラメータも必要です。

使用例

TagPrefixInfo コンストラクタを使用するコード例を次に示します。このコード例は、PagesSection クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' Add a TagPrefixInfo object using a constructor.
pagesSection.Controls.Add( _
 New System.Web.Configuration.TagPrefixInfo( _
 "MyCtrl", "MyNameSpace",
 "MyAssembly", "MyControl",
 _
 "MyControl.ascx"))

C#

// Add a TagPrefixInfo object using a constructor.
pagesSection.Controls.Add(
    new System.Web.Configuration.TagPrefixInfo(
    "MyCtrl", "MyNameSpace", "MyAssembly", "MyControl"
,
    "MyControl.ascx"));

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
TagPrefixInfo クラス
TagPrefixInfo メンバ
System.Web.Configuration 名前空間
PagesSection クラス

TagPrefixInfo プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Assembly	コントロールの実装を格納しているアセンブリの名前を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。 ( ConfigurationElement から継承されます。)
	Namespace	コントロールが存在する名前空間を取得または設定します。
	Source	ユーザー コントロールを含むファイルの名前とパスを取得または設定します。
	TagName	ユーザー コントロールの名前を取得または設定します。
	TagPrefix	ソース ファイルまたは名前空間とアセンブリに関連付けられるタグ プリフィックスを取得または設定します。

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。 ( ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。 ( ConfigurationElement から継承されます。)

参照

関連項目

TagPrefixInfo クラス
System.Web.Configuration 名前空間
PagesSection クラス
TagPrefixCollection クラス

その他の技術情報

pages 要素 (ASP.NET 設定スキーマ)
pages の controls 要素 (ASP.NET 設定スキーマ)

TagPrefixInfo メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。
	GetHashCode	オーバーライドされます。 現在のインスタンスのハッシュ値を返します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 ( ConfigurationElement から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 ( ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 ( ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 ( ConfigurationElement から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 ( ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 ( ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 ( ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 ( ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 ( ConfigurationElement から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 ( ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 ( ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 ( ConfigurationElement から継承されます。)

参照

関連項目

TagPrefixInfo クラス
System.Web.Configuration 名前空間
PagesSection クラス
TagPrefixCollection クラス

その他の技術情報

pages 要素 (ASP.NET 設定スキーマ)
pages の controls 要素 (ASP.NET 設定スキーマ)

TagPrefixInfo メンバ

タグ関連情報が格納される構成要素を定義します。

TagPrefixInfo データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	TagPrefixInfo	渡された値を使用して、TagPrefixInfo クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Assembly	コントロールの実装を格納しているアセンブリの名前を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 (ConfigurationElement から継承されます。)
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 (ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。(ConfigurationElement から継承されます。)
	Namespace	コントロールが存在する名前空間を取得または設定します。
	Source	ユーザー コントロールを含むファイルの名前とパスを取得または設定します。
	TagName	ユーザー コントロールの名前を取得または設定します。
	TagPrefix	ソース ファイルまたは名前空間とアセンブリに関連付けられるタグ プリフィックスを取得または設定します。

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。(ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。(ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。(ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。(ConfigurationElement から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。
	GetHashCode	オーバーライドされます。 現在のインスタンスのハッシュ値を返します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 (ConfigurationElement から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 (ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (ConfigurationElement から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 (ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 (ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 (ConfigurationElement から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 (ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 (ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (ConfigurationElement から継承されます。)

参照

関連項目

TagPrefixInfo クラス
System.Web.Configuration 名前空間
PagesSection クラス
TagPrefixCollection クラス

その他の技術情報

pages 要素 (ASP.NET 設定スキーマ)
pages の controls 要素 (ASP.NET 設定スキーマ)