TagPrefixInfo クラスとは何？わかりやすく解説 Weblio辞書

.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

public sealed class TagPrefixInfo : ConfigurationElement

C++

public ref class TagPrefixInfo sealed : public
 ConfigurationElement

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://weblio.hs.llnwd.net/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"))

// 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"));